Skip to main content

windmill_api/apis/
draft_api.rs

1/*
2 * Windmill API
3 *
4 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5 *
6 * The version of the OpenAPI document: 1.841.0
7 * Contact: contact@windmill.dev
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12use reqwest;
13use serde::{Deserialize, Serialize};
14use crate::{apis::ResponseContent, models};
15use super::{Error, configuration};
16
17
18/// struct for typed errors of method [`delete_draft_for_user`]
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(untagged)]
21pub enum DeleteDraftForUserError {
22    Status404(),
23    UnknownValue(serde_json::Value),
24}
25
26/// struct for typed errors of method [`get_draft_for_user`]
27#[derive(Debug, Clone, Serialize, Deserialize)]
28#[serde(untagged)]
29pub enum GetDraftForUserError {
30    Status404(),
31    UnknownValue(serde_json::Value),
32}
33
34/// struct for typed errors of method [`get_own_draft`]
35#[derive(Debug, Clone, Serialize, Deserialize)]
36#[serde(untagged)]
37pub enum GetOwnDraftError {
38    UnknownValue(serde_json::Value),
39}
40
41/// struct for typed errors of method [`list_drafts`]
42#[derive(Debug, Clone, Serialize, Deserialize)]
43#[serde(untagged)]
44pub enum ListDraftsError {
45    UnknownValue(serde_json::Value),
46}
47
48/// struct for typed errors of method [`migrate_legacy_draft`]
49#[derive(Debug, Clone, Serialize, Deserialize)]
50#[serde(untagged)]
51pub enum MigrateLegacyDraftError {
52    UnknownValue(serde_json::Value),
53}
54
55/// struct for typed errors of method [`move_draft`]
56#[derive(Debug, Clone, Serialize, Deserialize)]
57#[serde(untagged)]
58pub enum MoveDraftError {
59    UnknownValue(serde_json::Value),
60}
61
62/// struct for typed errors of method [`update_draft`]
63#[derive(Debug, Clone, Serialize, Deserialize)]
64#[serde(untagged)]
65pub enum UpdateDraftError {
66    UnknownValue(serde_json::Value),
67}
68
69
70/// Delete the draft a given user holds at a path, or, without `username`, every draft at that path (the legacy ownerless one and the caller's own included). Workspace admins / superadmins only, and only for script, flow, app and raw_app drafts. Unlike a discard of one's own draft through `drafts/update`, this returns 404 when nothing was deleted.
71pub async fn delete_draft_for_user(configuration: &configuration::Configuration, workspace: &str, kind: models::UserDraftItemKind, path: &str, username: Option<&str>) -> Result<String, Error<DeleteDraftForUserError>> {
72    let local_var_configuration = configuration;
73
74    let local_var_client = &local_var_configuration.client;
75
76    let local_var_uri_str = format!("{}/w/{workspace}/drafts/delete_for_user/{kind}/{path}", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace), kind=kind.to_string(), path=crate::apis::urlencode(path));
77    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
78
79    if let Some(ref local_var_str) = username {
80        local_var_req_builder = local_var_req_builder.query(&[("username", &local_var_str.to_string())]);
81    }
82    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
83        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
84    }
85    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
86        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
87    };
88
89    let local_var_req = local_var_req_builder.build()?;
90    let local_var_resp = local_var_client.execute(local_var_req).await?;
91
92    let local_var_status = local_var_resp.status();
93    let local_var_content = local_var_resp.text().await?;
94
95    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
96        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
97    } else {
98        let local_var_entity: Option<DeleteDraftForUserError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
99        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
100        Err(Error::ResponseError(local_var_error))
101    }
102}
103
104pub async fn get_draft_for_user(configuration: &configuration::Configuration, workspace: &str, kind: models::UserDraftItemKind, path: &str, username: Option<&str>) -> Result<models::GetDraftForUser200Response, Error<GetDraftForUserError>> {
105    let local_var_configuration = configuration;
106
107    let local_var_client = &local_var_configuration.client;
108
109    let local_var_uri_str = format!("{}/w/{workspace}/drafts/get/{kind}/{path}", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace), kind=kind.to_string(), path=crate::apis::urlencode(path));
110    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
111
112    if let Some(ref local_var_str) = username {
113        local_var_req_builder = local_var_req_builder.query(&[("username", &local_var_str.to_string())]);
114    }
115    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
116        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
117    }
118    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
119        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
120    };
121
122    let local_var_req = local_var_req_builder.build()?;
123    let local_var_resp = local_var_client.execute(local_var_req).await?;
124
125    let local_var_status = local_var_resp.status();
126    let local_var_content = local_var_resp.text().await?;
127
128    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
129        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
130    } else {
131        let local_var_entity: Option<GetDraftForUserError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
132        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
133        Err(Error::ResponseError(local_var_error))
134    }
135}
136
137pub async fn get_own_draft(configuration: &configuration::Configuration, workspace: &str, kind: models::UserDraftItemKind, path: &str) -> Result<models::GetOwnDraft200Response, Error<GetOwnDraftError>> {
138    let local_var_configuration = configuration;
139
140    let local_var_client = &local_var_configuration.client;
141
142    let local_var_uri_str = format!("{}/w/{workspace}/drafts/get_own/{kind}/{path}", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace), kind=kind.to_string(), path=crate::apis::urlencode(path));
143    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
144
145    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
146        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
147    }
148    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
149        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
150    };
151
152    let local_var_req = local_var_req_builder.build()?;
153    let local_var_resp = local_var_client.execute(local_var_req).await?;
154
155    let local_var_status = local_var_resp.status();
156    let local_var_content = local_var_resp.text().await?;
157
158    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
159        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
160    } else {
161        let local_var_entity: Option<GetOwnDraftError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
162        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
163        Err(Error::ResponseError(local_var_error))
164    }
165}
166
167pub async fn list_drafts(configuration: &configuration::Configuration, workspace: &str, all_users: Option<bool>, compare_to_workspace: Option<&str>) -> Result<Vec<models::ListDrafts200ResponseInner>, Error<ListDraftsError>> {
168    let local_var_configuration = configuration;
169
170    let local_var_client = &local_var_configuration.client;
171
172    let local_var_uri_str = format!("{}/w/{workspace}/drafts/list", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace));
173    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
174
175    if let Some(ref local_var_str) = all_users {
176        local_var_req_builder = local_var_req_builder.query(&[("all_users", &local_var_str.to_string())]);
177    }
178    if let Some(ref local_var_str) = compare_to_workspace {
179        local_var_req_builder = local_var_req_builder.query(&[("compare_to_workspace", &local_var_str.to_string())]);
180    }
181    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
182        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
183    }
184    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
185        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
186    };
187
188    let local_var_req = local_var_req_builder.build()?;
189    let local_var_resp = local_var_client.execute(local_var_req).await?;
190
191    let local_var_status = local_var_resp.status();
192    let local_var_content = local_var_resp.text().await?;
193
194    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
195        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
196    } else {
197        let local_var_entity: Option<ListDraftsError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
198        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
199        Err(Error::ResponseError(local_var_error))
200    }
201}
202
203/// Delete a legacy draft (email NULL) or assign it to the authed admin as a per-user draft. Workspace admins / superadmins only.
204pub async fn migrate_legacy_draft(configuration: &configuration::Configuration, workspace: &str, kind: models::UserDraftItemKind, path: &str, migrate_legacy_draft_request: models::MigrateLegacyDraftRequest) -> Result<String, Error<MigrateLegacyDraftError>> {
205    let local_var_configuration = configuration;
206
207    let local_var_client = &local_var_configuration.client;
208
209    let local_var_uri_str = format!("{}/w/{workspace}/drafts/migrate_legacy/{kind}/{path}", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace), kind=kind.to_string(), path=crate::apis::urlencode(path));
210    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
211
212    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
213        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
214    }
215    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
216        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
217    };
218    local_var_req_builder = local_var_req_builder.json(&migrate_legacy_draft_request);
219
220    let local_var_req = local_var_req_builder.build()?;
221    let local_var_resp = local_var_client.execute(local_var_req).await?;
222
223    let local_var_status = local_var_resp.status();
224    let local_var_content = local_var_resp.text().await?;
225
226    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
227        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
228    } else {
229        let local_var_entity: Option<MigrateLegacyDraftError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
230        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
231        Err(Error::ResponseError(local_var_error))
232    }
233}
234
235/// Relocates the authed user's own draft row, along with both path keys inside its value (the typed path and the mirror the editors keep beside it). Only for draft-only items — a deployed item must be moved through its own deploy endpoint, which carries every draft with it. Restricted to script, flow, app and raw_app; any other kind is rejected with 400, because only these keep their deploy target where this endpoint rewrites it.
236pub async fn move_draft(configuration: &configuration::Configuration, workspace: &str, kind: &str, path: &str, move_draft_request: models::MoveDraftRequest) -> Result<String, Error<MoveDraftError>> {
237    let local_var_configuration = configuration;
238
239    let local_var_client = &local_var_configuration.client;
240
241    let local_var_uri_str = format!("{}/w/{workspace}/drafts/move/{kind}/{path}", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace), kind=crate::apis::urlencode(kind), path=crate::apis::urlencode(path));
242    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
243
244    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
245        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
246    }
247    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
248        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
249    };
250    local_var_req_builder = local_var_req_builder.json(&move_draft_request);
251
252    let local_var_req = local_var_req_builder.build()?;
253    let local_var_resp = local_var_client.execute(local_var_req).await?;
254
255    let local_var_status = local_var_resp.status();
256    let local_var_content = local_var_resp.text().await?;
257
258    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
259        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
260    } else {
261        let local_var_entity: Option<MoveDraftError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
262        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
263        Err(Error::ResponseError(local_var_error))
264    }
265}
266
267pub async fn update_draft(configuration: &configuration::Configuration, workspace: &str, kind: models::UserDraftItemKind, path: &str, update_draft_request: models::UpdateDraftRequest) -> Result<models::UpdateDraft200Response, Error<UpdateDraftError>> {
268    let local_var_configuration = configuration;
269
270    let local_var_client = &local_var_configuration.client;
271
272    let local_var_uri_str = format!("{}/w/{workspace}/drafts/update/{kind}/{path}", local_var_configuration.base_path, workspace=crate::apis::urlencode(workspace), kind=kind.to_string(), path=crate::apis::urlencode(path));
273    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
274
275    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
276        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
277    }
278    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
279        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
280    };
281    local_var_req_builder = local_var_req_builder.json(&update_draft_request);
282
283    let local_var_req = local_var_req_builder.build()?;
284    let local_var_resp = local_var_client.execute(local_var_req).await?;
285
286    let local_var_status = local_var_resp.status();
287    let local_var_content = local_var_resp.text().await?;
288
289    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
290        crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).map_err(Error::from)
291    } else {
292        let local_var_entity: Option<UpdateDraftError> = crate::from_str_patched/* Externally injected from /build.nu */(&local_var_content).ok();
293        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
294        Err(Error::ResponseError(local_var_error))
295    }
296}
297