rippling_api/
leave_requests.rs

1use anyhow::Result;
2
3use crate::Client;
4#[derive(Clone, Debug)]
5pub struct LeaveRequests {
6    pub client: Client,
7}
8
9impl LeaveRequests {
10    #[doc(hidden)]
11    pub fn new(client: Client) -> Self {
12        Self { client }
13    }
14
15    #[doc = "List leave requests\n\nA List of leave requests\n- Requires: `API Tier 2`\n- Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`, `leave_policy_id`, `leave_type_id`\n- Expandable fields: `worker`, `requester`, `leave_type`, `reviewer`\n- Sortable fields: `id`, `created_at`, `updated_at`\n\n**Parameters:**\n\n- `cursor: Option<String>`\n- `expand: Option<String>`\n- `filter: Option<String>`\n- `order_by: Option<String>`\n\n```rust,no_run\nuse futures_util::TryStreamExt;\nasync fn example_leave_requests_list_stream() -> anyhow::Result<()> {\n    let client = rippling_api::Client::new_from_env();\n    let mut leave_requests = client.leave_requests();\n    let mut stream = leave_requests.list_stream(\n        Some(\"some-string\".to_string()),\n        Some(\"some-string\".to_string()),\n        Some(\"some-string\".to_string()),\n    );\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```"]
16    #[tracing::instrument]
17    pub async fn list<'a>(
18        &'a self,
19        cursor: Option<String>,
20        expand: Option<String>,
21        filter: Option<String>,
22        order_by: Option<String>,
23    ) -> Result<crate::types::ListLeaveRequestsResponse, crate::types::error::Error> {
24        let mut req = self.client.client.request(
25            http::Method::GET,
26            format!("{}/{}", self.client.base_url, "leave-requests"),
27        );
28        req = req.bearer_auth(&self.client.token);
29        let mut query_params = vec![];
30        if let Some(p) = cursor {
31            query_params.push(("cursor", p));
32        }
33
34        if let Some(p) = expand {
35            query_params.push(("expand", p));
36        }
37
38        if let Some(p) = filter {
39            query_params.push(("filter", p));
40        }
41
42        if let Some(p) = order_by {
43            query_params.push(("order_by", p));
44        }
45
46        req = req.query(&query_params);
47        let resp = req.send().await?;
48        let status = resp.status();
49        if status.is_success() {
50            let text = resp.text().await.unwrap_or_default();
51            serde_json::from_str(&text).map_err(|err| {
52                crate::types::error::Error::from_serde_error(
53                    format_serde_error::SerdeError::new(text.to_string(), err),
54                    status,
55                )
56            })
57        } else {
58            let text = resp.text().await.unwrap_or_default();
59            Err(crate::types::error::Error::Server {
60                body: text.to_string(),
61                status,
62            })
63        }
64    }
65
66    #[doc = "List leave requests\n\nA List of leave requests\n- Requires: `API Tier 2`\n- Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`, `leave_policy_id`, `leave_type_id`\n- Expandable fields: `worker`, `requester`, `leave_type`, `reviewer`\n- Sortable fields: `id`, `created_at`, `updated_at`\n\n**Parameters:**\n\n- `cursor: Option<String>`\n- `expand: Option<String>`\n- `filter: Option<String>`\n- `order_by: Option<String>`\n\n```rust,no_run\nuse futures_util::TryStreamExt;\nasync fn example_leave_requests_list_stream() -> anyhow::Result<()> {\n    let client = rippling_api::Client::new_from_env();\n    let mut leave_requests = client.leave_requests();\n    let mut stream = leave_requests.list_stream(\n        Some(\"some-string\".to_string()),\n        Some(\"some-string\".to_string()),\n        Some(\"some-string\".to_string()),\n    );\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```"]
67    #[tracing::instrument]
68    #[cfg(not(feature = "js"))]
69    pub fn list_stream<'a>(
70        &'a self,
71        expand: Option<String>,
72        filter: Option<String>,
73        order_by: Option<String>,
74    ) -> impl futures::Stream<Item = Result<crate::types::LeaveRequest, crate::types::error::Error>>
75           + Unpin
76           + '_ {
77        use futures::{StreamExt, TryFutureExt, TryStreamExt};
78
79        use crate::types::paginate::Pagination;
80        self.list(None, expand, filter, order_by)
81            .map_ok(move |result| {
82                let items = futures::stream::iter(result.items().into_iter().map(Ok));
83                let next_pages = futures::stream::try_unfold(
84                    (None, result),
85                    move |(prev_page_token, new_result)| async move {
86                        if new_result.has_more_pages()
87                            && !new_result.items().is_empty()
88                            && prev_page_token != new_result.next_page_token()
89                        {
90                            async {
91                                let mut req = self.client.client.request(
92                                    http::Method::GET,
93                                    format!("{}/{}", self.client.base_url, "leave-requests"),
94                                );
95                                req = req.bearer_auth(&self.client.token);
96                                let mut request = req.build()?;
97                                request = new_result.next_page(request)?;
98                                let resp = self.client.client.execute(request).await?;
99                                let status = resp.status();
100                                if status.is_success() {
101                                    let text = resp.text().await.unwrap_or_default();
102                                    serde_json::from_str(&text).map_err(|err| {
103                                        crate::types::error::Error::from_serde_error(
104                                            format_serde_error::SerdeError::new(
105                                                text.to_string(),
106                                                err,
107                                            ),
108                                            status,
109                                        )
110                                    })
111                                } else {
112                                    let text = resp.text().await.unwrap_or_default();
113                                    Err(crate::types::error::Error::Server {
114                                        body: text.to_string(),
115                                        status,
116                                    })
117                                }
118                            }
119                            .map_ok(|result: crate::types::ListLeaveRequestsResponse| {
120                                Some((
121                                    futures::stream::iter(result.items().into_iter().map(Ok)),
122                                    (new_result.next_page_token(), result),
123                                ))
124                            })
125                            .await
126                        } else {
127                            Ok(None)
128                        }
129                    },
130                )
131                .try_flatten();
132                items.chain(next_pages)
133            })
134            .try_flatten_stream()
135            .boxed()
136    }
137
138    #[doc = "Create a new leave request\n\nCreate a new leave request\n\n```rust,no_run\nasync fn \
139             example_leave_requests_create() -> anyhow::Result<()> {\n    let client = \
140             rippling_api::Client::new_from_env();\n    let result: \
141             rippling_api::types::LeaveRequest = client\n        .leave_requests()\n        \
142             .create(&rippling_api::types::LeaveRequestRequest {\n            worker_id: \
143             \"some-string\".to_string(),\n            requester_id: \
144             Some(\"some-string\".to_string()),\n            status: \
145             rippling_api::types::LeaveRequestRequestStatus::Rejected,\n            start_date: \
146             \"some-string\".to_string(),\n            start_time: \
147             Some(\"some-string\".to_string()),\n            end_date: \
148             \"some-string\".to_string(),\n            end_time: \
149             Some(\"some-string\".to_string()),\n            start_date_custom_hours: Some(3.14 as \
150             f64),\n            end_date_custom_hours: Some(3.14 as f64),\n            comments: \
151             Some(\"some-string\".to_string()),\n            leave_policy_id: \
152             \"some-string\".to_string(),\n            leave_type_id: \
153             Some(\"some-string\".to_string()),\n            reason_for_leave: \
154             Some(\"some-string\".to_string()),\n            reviewer_id: \
155             Some(\"some-string\".to_string()),\n            reviewed_at: \
156             Some(\"some-string\".to_string()),\n        })\n        .await?;\n    \
157             println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
158    #[tracing::instrument]
159    pub async fn create<'a>(
160        &'a self,
161        body: &crate::types::LeaveRequestRequest,
162    ) -> Result<crate::types::LeaveRequest, crate::types::error::Error> {
163        let mut req = self.client.client.request(
164            http::Method::POST,
165            format!("{}/{}", self.client.base_url, "leave-requests"),
166        );
167        req = req.bearer_auth(&self.client.token);
168        req = req.json(body);
169        let resp = req.send().await?;
170        let status = resp.status();
171        if status.is_success() {
172            let text = resp.text().await.unwrap_or_default();
173            serde_json::from_str(&text).map_err(|err| {
174                crate::types::error::Error::from_serde_error(
175                    format_serde_error::SerdeError::new(text.to_string(), err),
176                    status,
177                )
178            })
179        } else {
180            let text = resp.text().await.unwrap_or_default();
181            Err(crate::types::error::Error::Server {
182                body: text.to_string(),
183                status,
184            })
185        }
186    }
187
188    #[doc = "Retrieve a specific leave request\n\nRetrieve a specific leave request\n\n**Parameters:**\n\n- `expand: Option<String>`\n- `id: &'astr`: ID of the resource to return (required)\n\n```rust,no_run\nasync fn example_leave_requests_get() -> anyhow::Result<()> {\n    let client = rippling_api::Client::new_from_env();\n    let result: rippling_api::types::GetLeaveRequestsResponse = client\n        .leave_requests()\n        .get(\n            Some(\"some-string\".to_string()),\n            \"d9797f8d-9ad6-4e08-90d7-2ec17e13471c\",\n        )\n        .await?;\n    println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
189    #[tracing::instrument]
190    pub async fn get<'a>(
191        &'a self,
192        expand: Option<String>,
193        id: &'a str,
194    ) -> Result<crate::types::GetLeaveRequestsResponse, crate::types::error::Error> {
195        let mut req = self.client.client.request(
196            http::Method::GET,
197            format!(
198                "{}/{}",
199                self.client.base_url,
200                "leave-requests/{id}".replace("{id}", id)
201            ),
202        );
203        req = req.bearer_auth(&self.client.token);
204        let mut query_params = vec![];
205        if let Some(p) = expand {
206            query_params.push(("expand", p));
207        }
208
209        req = req.query(&query_params);
210        let resp = req.send().await?;
211        let status = resp.status();
212        if status.is_success() {
213            let text = resp.text().await.unwrap_or_default();
214            serde_json::from_str(&text).map_err(|err| {
215                crate::types::error::Error::from_serde_error(
216                    format_serde_error::SerdeError::new(text.to_string(), err),
217                    status,
218                )
219            })
220        } else {
221            let text = resp.text().await.unwrap_or_default();
222            Err(crate::types::error::Error::Server {
223                body: text.to_string(),
224                status,
225            })
226        }
227    }
228
229    #[doc = "Update a leave request\n\nUpdated a specific leave request\n\n**Parameters:**\n\n- `id: &'astr`: ID of the resource to patch (required)\n\n```rust,no_run\nasync fn example_leave_requests_update() -> anyhow::Result<()> {\n    let client = rippling_api::Client::new_from_env();\n    let result: rippling_api::types::LeaveRequest = client\n        .leave_requests()\n        .update(\n            \"d9797f8d-9ad6-4e08-90d7-2ec17e13471c\",\n            &rippling_api::types::LeaveRequestRequest {\n                worker_id: \"some-string\".to_string(),\n                requester_id: Some(\"some-string\".to_string()),\n                status: rippling_api::types::LeaveRequestRequestStatus::Rejected,\n                start_date: \"some-string\".to_string(),\n                start_time: Some(\"some-string\".to_string()),\n                end_date: \"some-string\".to_string(),\n                end_time: Some(\"some-string\".to_string()),\n                start_date_custom_hours: Some(3.14 as f64),\n                end_date_custom_hours: Some(3.14 as f64),\n                comments: Some(\"some-string\".to_string()),\n                leave_policy_id: \"some-string\".to_string(),\n                leave_type_id: Some(\"some-string\".to_string()),\n                reason_for_leave: Some(\"some-string\".to_string()),\n                reviewer_id: Some(\"some-string\".to_string()),\n                reviewed_at: Some(\"some-string\".to_string()),\n            },\n        )\n        .await?;\n    println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
230    #[tracing::instrument]
231    pub async fn update<'a>(
232        &'a self,
233        id: &'a str,
234        body: &crate::types::LeaveRequestRequest,
235    ) -> Result<crate::types::LeaveRequest, crate::types::error::Error> {
236        let mut req = self.client.client.request(
237            http::Method::PATCH,
238            format!(
239                "{}/{}",
240                self.client.base_url,
241                "leave-requests/{id}".replace("{id}", id)
242            ),
243        );
244        req = req.bearer_auth(&self.client.token);
245        req = req.json(body);
246        let resp = req.send().await?;
247        let status = resp.status();
248        if status.is_success() {
249            let text = resp.text().await.unwrap_or_default();
250            serde_json::from_str(&text).map_err(|err| {
251                crate::types::error::Error::from_serde_error(
252                    format_serde_error::SerdeError::new(text.to_string(), err),
253                    status,
254                )
255            })
256        } else {
257            let text = resp.text().await.unwrap_or_default();
258            Err(crate::types::error::Error::Server {
259                body: text.to_string(),
260                status,
261            })
262        }
263    }
264}