1use crate::Client;
2use anyhow::Result;
3#[derive(Clone, Debug)]
4pub struct WorkflowActions {
5 pub client: Client,
6}
7
8impl WorkflowActions {
9 #[doc(hidden)]
10 pub fn new(client: Client) -> Self {
11 Self { client }
12 }
13
14 #[doc = "Perform a `GET` request to `/api/workflow_actions/`.\n\n**Parameters:**\n\n- `page: Option<i64>`: A page number within the paginated result set.\n- `page_size: Option<i64>`: Number of results to return per page.\n\n```rust,no_run\nuse futures_util::TryStreamExt;\nasync fn example_workflow_actions_list_stream() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n let mut workflow_actions = client.workflow_actions();\n let mut stream = workflow_actions.list_stream(Some(4 as i64));\n loop {\n match stream.try_next().await {\n Ok(Some(item)) => {\n println!(\"{:?}\", item);\n }\n Ok(None) => {\n break;\n }\n Err(err) => {\n return Err(err.into());\n }\n }\n }\n\n Ok(())\n}\n```"]
15 #[tracing::instrument]
16 #[allow(non_snake_case)]
17 pub async fn list<'a>(
18 &'a self,
19 page: Option<i64>,
20 page_size: Option<i64>,
21 ) -> Result<crate::types::PaginatedWorkflowActionList, crate::types::error::Error> {
22 let mut req = self.client.client.request(
23 http::Method::GET,
24 format!("{}/{}", self.client.base_url, "api/workflow_actions/"),
25 );
26 req = req.header("Authorization", format!("Token {}", &self.client.token));
27 let mut query_params = vec![];
28 if let Some(p) = page {
29 query_params.push(("page", format!("{p}")));
30 }
31
32 if let Some(p) = page_size {
33 query_params.push(("page_size", format!("{p}")));
34 }
35
36 req = req.query(&query_params);
37 let resp = req.send().await?;
38 let status = resp.status();
39 if status.is_success() {
40 let text = resp.text().await.unwrap_or_default();
41 serde_json::from_str(&text).map_err(|err| {
42 crate::types::error::Error::from_serde_error(
43 format_serde_error::SerdeError::new(text.to_string(), err),
44 status,
45 )
46 })
47 } else {
48 let text = resp.text().await.unwrap_or_default();
49 Err(crate::types::error::Error::Server {
50 body: text.to_string(),
51 status,
52 })
53 }
54 }
55
56 #[doc = "Perform a `GET` request to `/api/workflow_actions/`.\n\n**Parameters:**\n\n- `page: Option<i64>`: A page number within the paginated result set.\n- `page_size: Option<i64>`: Number of results to return per page.\n\n```rust,no_run\nuse futures_util::TryStreamExt;\nasync fn example_workflow_actions_list_stream() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n let mut workflow_actions = client.workflow_actions();\n let mut stream = workflow_actions.list_stream(Some(4 as i64));\n loop {\n match stream.try_next().await {\n Ok(Some(item)) => {\n println!(\"{:?}\", item);\n }\n Ok(None) => {\n break;\n }\n Err(err) => {\n return Err(err.into());\n }\n }\n }\n\n Ok(())\n}\n```"]
57 #[tracing::instrument]
58 #[cfg(not(feature = "js"))]
59 #[allow(non_snake_case)]
60 pub fn list_stream<'a>(
61 &'a self,
62 page_size: Option<i64>,
63 ) -> impl futures::Stream<Item = Result<crate::types::WorkflowAction, crate::types::error::Error>>
64 + Unpin
65 + '_ {
66 use crate::types::paginate::Pagination;
67 use futures::{StreamExt, TryFutureExt, TryStreamExt};
68 self.list(None, page_size)
69 .map_ok(move |result| {
70 let items = futures::stream::iter(result.items().into_iter().map(Ok));
71 let next_pages = futures::stream::try_unfold(
72 (None, result),
73 move |(prev_page_token, new_result)| async move {
74 if new_result.has_more_pages()
75 && !new_result.items().is_empty()
76 && prev_page_token != new_result.next_page_token()
77 {
78 async {
79 let mut req = self.client.client.request(
80 http::Method::GET,
81 format!("{}/{}", self.client.base_url, "api/workflow_actions/"),
82 );
83 req = req.header(
84 "Authorization",
85 format!("Token {}", &self.client.token),
86 );
87 let mut request = req.build()?;
88 request = new_result.next_page(request)?;
89 let resp = self.client.client.execute(request).await?;
90 let status = resp.status();
91 if status.is_success() {
92 let text = resp.text().await.unwrap_or_default();
93 serde_json::from_str(&text).map_err(|err| {
94 crate::types::error::Error::from_serde_error(
95 format_serde_error::SerdeError::new(
96 text.to_string(),
97 err,
98 ),
99 status,
100 )
101 })
102 } else {
103 let text = resp.text().await.unwrap_or_default();
104 Err(crate::types::error::Error::Server {
105 body: text.to_string(),
106 status,
107 })
108 }
109 }
110 .map_ok(|result: crate::types::PaginatedWorkflowActionList| {
111 Some((
112 futures::stream::iter(result.items().into_iter().map(Ok)),
113 (new_result.next_page_token(), result),
114 ))
115 })
116 .await
117 } else {
118 Ok(None)
119 }
120 },
121 )
122 .try_flatten();
123 items.chain(next_pages)
124 })
125 .try_flatten_stream()
126 .boxed()
127 }
128
129 #[doc = "Perform a `POST` request to `/api/workflow_actions/`.\n\n```rust,no_run\nasync fn example_workflow_actions_create() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n let result: paperless_api_client::types::WorkflowAction = client\n .workflow_actions()\n .create(&paperless_api_client::types::WorkflowActionRequest {\n id: Some(4 as i64),\n type_: Some(4 as i64),\n assign_title: Some(\"some-string\".to_string()),\n assign_tags: Some(vec![4 as i64]),\n assign_correspondent: Some(4 as i64),\n assign_document_type: Some(4 as i64),\n assign_storage_path: Some(4 as i64),\n assign_owner: Some(4 as i64),\n assign_view_users: Some(vec![4 as i64]),\n assign_view_groups: Some(vec![4 as i64]),\n assign_change_users: Some(vec![4 as i64]),\n assign_change_groups: Some(vec![4 as i64]),\n assign_custom_fields: Some(vec![4 as i64]),\n assign_custom_fields_values: Some(serde_json::Value::String(\"some-string\".to_string())),\n remove_all_tags: Some(true),\n remove_tags: Some(vec![4 as i64]),\n remove_all_correspondents: Some(true),\n remove_correspondents: Some(vec![4 as i64]),\n remove_all_document_types: Some(true),\n remove_document_types: Some(vec![4 as i64]),\n remove_all_storage_paths: Some(true),\n remove_storage_paths: Some(vec![4 as i64]),\n remove_custom_fields: Some(vec![4 as i64]),\n remove_all_custom_fields: Some(true),\n remove_all_owners: Some(true),\n remove_owners: Some(vec![4 as i64]),\n remove_all_permissions: Some(true),\n remove_view_users: Some(vec![4 as i64]),\n remove_view_groups: Some(vec![4 as i64]),\n remove_change_users: Some(vec![4 as i64]),\n remove_change_groups: Some(vec![4 as i64]),\n email: Some(paperless_api_client::types::WorkflowActionEmailRequest {\n id: Some(4 as i64),\n subject: \"some-string\".to_string(),\n body: \"some-string\".to_string(),\n to: \"some-string\".to_string(),\n include_document: Some(true),\n }),\n webhook: Some(paperless_api_client::types::WorkflowActionWebhookRequest {\n id: Some(4 as i64),\n url: \"some-string\".to_string(),\n use_params: Some(true),\n as_json: Some(true),\n params: Some(serde_json::Value::String(\"some-string\".to_string())),\n body: Some(\"some-string\".to_string()),\n headers: Some(serde_json::Value::String(\"some-string\".to_string())),\n include_document: Some(true),\n }),\n })\n .await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n```"]
130 #[tracing::instrument]
131 #[allow(non_snake_case)]
132 pub async fn create<'a>(
133 &'a self,
134 body: &crate::types::WorkflowActionRequest,
135 ) -> Result<crate::types::WorkflowAction, crate::types::error::Error> {
136 let mut req = self.client.client.request(
137 http::Method::POST,
138 format!("{}/{}", self.client.base_url, "api/workflow_actions/"),
139 );
140 req = req.header("Authorization", format!("Token {}", &self.client.token));
141 req = req.json(body);
142 let resp = req.send().await?;
143 let status = resp.status();
144 if status.is_success() {
145 let text = resp.text().await.unwrap_or_default();
146 serde_json::from_str(&text).map_err(|err| {
147 crate::types::error::Error::from_serde_error(
148 format_serde_error::SerdeError::new(text.to_string(), err),
149 status,
150 )
151 })
152 } else {
153 let text = resp.text().await.unwrap_or_default();
154 Err(crate::types::error::Error::Server {
155 body: text.to_string(),
156 status,
157 })
158 }
159 }
160
161 #[doc = "Perform a `GET` request to `/api/workflow_actions/{id}/`.\n\n**Parameters:**\n\n- `id: i64`: A unique integer value identifying this workflow action. (required)\n\n```rust,no_run\nasync fn example_workflow_actions_retrieve() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n let result: paperless_api_client::types::WorkflowAction = client.workflow_actions().retrieve(4 as i64).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n```"]
162 #[tracing::instrument]
163 #[allow(non_snake_case)]
164 pub async fn retrieve<'a>(
165 &'a self,
166 id: i64,
167 ) -> Result<crate::types::WorkflowAction, crate::types::error::Error> {
168 let mut req = self.client.client.request(
169 http::Method::GET,
170 format!(
171 "{}/{}",
172 self.client.base_url,
173 "api/workflow_actions/{id}/".replace("{id}", &format!("{id}"))
174 ),
175 );
176 req = req.header("Authorization", format!("Token {}", &self.client.token));
177 let resp = req.send().await?;
178 let status = resp.status();
179 if status.is_success() {
180 let text = resp.text().await.unwrap_or_default();
181 serde_json::from_str(&text).map_err(|err| {
182 crate::types::error::Error::from_serde_error(
183 format_serde_error::SerdeError::new(text.to_string(), err),
184 status,
185 )
186 })
187 } else {
188 let text = resp.text().await.unwrap_or_default();
189 Err(crate::types::error::Error::Server {
190 body: text.to_string(),
191 status,
192 })
193 }
194 }
195
196 #[doc = "Perform a `PUT` request to `/api/workflow_actions/{id}/`.\n\n**Parameters:**\n\n- `id: i64`: A unique integer value identifying this workflow action. (required)\n\n```rust,no_run\nasync fn example_workflow_actions_update() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n let result: paperless_api_client::types::WorkflowAction = client\n .workflow_actions()\n .update(\n 4 as i64,\n &paperless_api_client::types::WorkflowActionRequest {\n id: Some(4 as i64),\n type_: Some(4 as i64),\n assign_title: Some(\"some-string\".to_string()),\n assign_tags: Some(vec![4 as i64]),\n assign_correspondent: Some(4 as i64),\n assign_document_type: Some(4 as i64),\n assign_storage_path: Some(4 as i64),\n assign_owner: Some(4 as i64),\n assign_view_users: Some(vec![4 as i64]),\n assign_view_groups: Some(vec![4 as i64]),\n assign_change_users: Some(vec![4 as i64]),\n assign_change_groups: Some(vec![4 as i64]),\n assign_custom_fields: Some(vec![4 as i64]),\n assign_custom_fields_values: Some(serde_json::Value::String(\n \"some-string\".to_string(),\n )),\n remove_all_tags: Some(true),\n remove_tags: Some(vec![4 as i64]),\n remove_all_correspondents: Some(true),\n remove_correspondents: Some(vec![4 as i64]),\n remove_all_document_types: Some(true),\n remove_document_types: Some(vec![4 as i64]),\n remove_all_storage_paths: Some(true),\n remove_storage_paths: Some(vec![4 as i64]),\n remove_custom_fields: Some(vec![4 as i64]),\n remove_all_custom_fields: Some(true),\n remove_all_owners: Some(true),\n remove_owners: Some(vec![4 as i64]),\n remove_all_permissions: Some(true),\n remove_view_users: Some(vec![4 as i64]),\n remove_view_groups: Some(vec![4 as i64]),\n remove_change_users: Some(vec![4 as i64]),\n remove_change_groups: Some(vec![4 as i64]),\n email: Some(paperless_api_client::types::WorkflowActionEmailRequest {\n id: Some(4 as i64),\n subject: \"some-string\".to_string(),\n body: \"some-string\".to_string(),\n to: \"some-string\".to_string(),\n include_document: Some(true),\n }),\n webhook: Some(paperless_api_client::types::WorkflowActionWebhookRequest {\n id: Some(4 as i64),\n url: \"some-string\".to_string(),\n use_params: Some(true),\n as_json: Some(true),\n params: Some(serde_json::Value::String(\"some-string\".to_string())),\n body: Some(\"some-string\".to_string()),\n headers: Some(serde_json::Value::String(\"some-string\".to_string())),\n include_document: Some(true),\n }),\n },\n )\n .await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n```"]
197 #[tracing::instrument]
198 #[allow(non_snake_case)]
199 pub async fn update<'a>(
200 &'a self,
201 id: i64,
202 body: &crate::types::WorkflowActionRequest,
203 ) -> Result<crate::types::WorkflowAction, crate::types::error::Error> {
204 let mut req = self.client.client.request(
205 http::Method::PUT,
206 format!(
207 "{}/{}",
208 self.client.base_url,
209 "api/workflow_actions/{id}/".replace("{id}", &format!("{id}"))
210 ),
211 );
212 req = req.header("Authorization", format!("Token {}", &self.client.token));
213 req = req.json(body);
214 let resp = req.send().await?;
215 let status = resp.status();
216 if status.is_success() {
217 let text = resp.text().await.unwrap_or_default();
218 serde_json::from_str(&text).map_err(|err| {
219 crate::types::error::Error::from_serde_error(
220 format_serde_error::SerdeError::new(text.to_string(), err),
221 status,
222 )
223 })
224 } else {
225 let text = resp.text().await.unwrap_or_default();
226 Err(crate::types::error::Error::Server {
227 body: text.to_string(),
228 status,
229 })
230 }
231 }
232
233 #[doc = "Perform a `DELETE` request to `/api/workflow_actions/{id}/`.\n\n**Parameters:**\n\n- `id: i64`: A unique integer value identifying this workflow action. (required)\n\n```rust,no_run\nasync fn example_workflow_actions_destroy() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n client.workflow_actions().destroy(4 as i64).await?;\n Ok(())\n}\n```"]
234 #[tracing::instrument]
235 #[allow(non_snake_case)]
236 pub async fn destroy<'a>(&'a self, id: i64) -> Result<(), crate::types::error::Error> {
237 let mut req = self.client.client.request(
238 http::Method::DELETE,
239 format!(
240 "{}/{}",
241 self.client.base_url,
242 "api/workflow_actions/{id}/".replace("{id}", &format!("{id}"))
243 ),
244 );
245 req = req.header("Authorization", format!("Token {}", &self.client.token));
246 let resp = req.send().await?;
247 let status = resp.status();
248 if status.is_success() {
249 Ok(())
250 } else {
251 let text = resp.text().await.unwrap_or_default();
252 Err(crate::types::error::Error::Server {
253 body: text.to_string(),
254 status,
255 })
256 }
257 }
258
259 #[doc = "Perform a `PATCH` request to `/api/workflow_actions/{id}/`.\n\n**Parameters:**\n\n- `id: i64`: A unique integer value identifying this workflow action. (required)\n\n```rust,no_run\nasync fn example_workflow_actions_partial_update() -> anyhow::Result<()> {\n let client = paperless_api_client::Client::new_from_env();\n let result: paperless_api_client::types::WorkflowAction = client\n .workflow_actions()\n .partial_update(\n 4 as i64,\n &paperless_api_client::types::PatchedWorkflowActionRequest {\n id: Some(4 as i64),\n type_: Some(4 as i64),\n assign_title: Some(\"some-string\".to_string()),\n assign_tags: Some(vec![4 as i64]),\n assign_correspondent: Some(4 as i64),\n assign_document_type: Some(4 as i64),\n assign_storage_path: Some(4 as i64),\n assign_owner: Some(4 as i64),\n assign_view_users: Some(vec![4 as i64]),\n assign_view_groups: Some(vec![4 as i64]),\n assign_change_users: Some(vec![4 as i64]),\n assign_change_groups: Some(vec![4 as i64]),\n assign_custom_fields: Some(vec![4 as i64]),\n assign_custom_fields_values: Some(serde_json::Value::String(\n \"some-string\".to_string(),\n )),\n remove_all_tags: Some(true),\n remove_tags: Some(vec![4 as i64]),\n remove_all_correspondents: Some(true),\n remove_correspondents: Some(vec![4 as i64]),\n remove_all_document_types: Some(true),\n remove_document_types: Some(vec![4 as i64]),\n remove_all_storage_paths: Some(true),\n remove_storage_paths: Some(vec![4 as i64]),\n remove_custom_fields: Some(vec![4 as i64]),\n remove_all_custom_fields: Some(true),\n remove_all_owners: Some(true),\n remove_owners: Some(vec![4 as i64]),\n remove_all_permissions: Some(true),\n remove_view_users: Some(vec![4 as i64]),\n remove_view_groups: Some(vec![4 as i64]),\n remove_change_users: Some(vec![4 as i64]),\n remove_change_groups: Some(vec![4 as i64]),\n email: Some(paperless_api_client::types::WorkflowActionEmailRequest {\n id: Some(4 as i64),\n subject: \"some-string\".to_string(),\n body: \"some-string\".to_string(),\n to: \"some-string\".to_string(),\n include_document: Some(true),\n }),\n webhook: Some(paperless_api_client::types::WorkflowActionWebhookRequest {\n id: Some(4 as i64),\n url: \"some-string\".to_string(),\n use_params: Some(true),\n as_json: Some(true),\n params: Some(serde_json::Value::String(\"some-string\".to_string())),\n body: Some(\"some-string\".to_string()),\n headers: Some(serde_json::Value::String(\"some-string\".to_string())),\n include_document: Some(true),\n }),\n },\n )\n .await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n```"]
260 #[tracing::instrument]
261 #[allow(non_snake_case)]
262 pub async fn partial_update<'a>(
263 &'a self,
264 id: i64,
265 body: &crate::types::PatchedWorkflowActionRequest,
266 ) -> Result<crate::types::WorkflowAction, crate::types::error::Error> {
267 let mut req = self.client.client.request(
268 http::Method::PATCH,
269 format!(
270 "{}/{}",
271 self.client.base_url,
272 "api/workflow_actions/{id}/".replace("{id}", &format!("{id}"))
273 ),
274 );
275 req = req.header("Authorization", format!("Token {}", &self.client.token));
276 req = req.json(body);
277 let resp = req.send().await?;
278 let status = resp.status();
279 if status.is_success() {
280 let text = resp.text().await.unwrap_or_default();
281 serde_json::from_str(&text).map_err(|err| {
282 crate::types::error::Error::from_serde_error(
283 format_serde_error::SerdeError::new(text.to_string(), err),
284 status,
285 )
286 })
287 } else {
288 let text = resp.text().await.unwrap_or_default();
289 Err(crate::types::error::Error::Server {
290 body: text.to_string(),
291 status,
292 })
293 }
294 }
295}