rippling_api/
workers.rs

1use anyhow::Result;
2
3use crate::Client;
4#[derive(Clone, Debug)]
5pub struct Workers {
6    pub client: Client,
7}
8
9impl Workers {
10    #[doc(hidden)]
11    pub fn new(client: Client) -> Self {
12        Self { client }
13    }
14
15    #[doc = "List workers\n\nA List of workers\n- Requires: `API Tier 1`\n- Filterable fields: `status`, `work_email`\n- Expandable fields: `user`, `manager`, `legal_entity`, `employment_type`, `compensation`, `department`, `teams`, `level`, `custom_fields`\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_workers_list_stream() -> anyhow::Result<()> {\n    let client = rippling_api::Client::new_from_env();\n    let mut workers = client.workers();\n    let mut stream = workers.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::ListWorkersResponse, crate::types::error::Error> {
24        let mut req = self.client.client.request(
25            http::Method::GET,
26            format!("{}/{}", self.client.base_url, "workers"),
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 workers\n\nA List of workers\n- Requires: `API Tier 1`\n- Filterable fields: `status`, `work_email`\n- Expandable fields: `user`, `manager`, `legal_entity`, `employment_type`, `compensation`, `department`, `teams`, `level`, `custom_fields`\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_workers_list_stream() -> anyhow::Result<()> {\n    let client = rippling_api::Client::new_from_env();\n    let mut workers = client.workers();\n    let mut stream = workers.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::Worker, crate::types::error::Error>> + Unpin + '_
75    {
76        use futures::{StreamExt, TryFutureExt, TryStreamExt};
77
78        use crate::types::paginate::Pagination;
79        self.list(None, expand, filter, order_by)
80            .map_ok(move |result| {
81                let items = futures::stream::iter(result.items().into_iter().map(Ok));
82                let next_pages = futures::stream::try_unfold(
83                    (None, result),
84                    move |(prev_page_token, new_result)| async move {
85                        if new_result.has_more_pages()
86                            && !new_result.items().is_empty()
87                            && prev_page_token != new_result.next_page_token()
88                        {
89                            async {
90                                let mut req = self.client.client.request(
91                                    http::Method::GET,
92                                    format!("{}/{}", self.client.base_url, "workers"),
93                                );
94                                req = req.bearer_auth(&self.client.token);
95                                let mut request = req.build()?;
96                                request = new_result.next_page(request)?;
97                                let resp = self.client.client.execute(request).await?;
98                                let status = resp.status();
99                                if status.is_success() {
100                                    let text = resp.text().await.unwrap_or_default();
101                                    serde_json::from_str(&text).map_err(|err| {
102                                        crate::types::error::Error::from_serde_error(
103                                            format_serde_error::SerdeError::new(
104                                                text.to_string(),
105                                                err,
106                                            ),
107                                            status,
108                                        )
109                                    })
110                                } else {
111                                    let text = resp.text().await.unwrap_or_default();
112                                    Err(crate::types::error::Error::Server {
113                                        body: text.to_string(),
114                                        status,
115                                    })
116                                }
117                            }
118                            .map_ok(|result: crate::types::ListWorkersResponse| {
119                                Some((
120                                    futures::stream::iter(result.items().into_iter().map(Ok)),
121                                    (new_result.next_page_token(), result),
122                                ))
123                            })
124                            .await
125                        } else {
126                            Ok(None)
127                        }
128                    },
129                )
130                .try_flatten();
131                items.chain(next_pages)
132            })
133            .try_flatten_stream()
134            .boxed()
135    }
136
137    #[doc = "Retrieve a specific worker\n\nRetrieve a specific worker\n\n**Parameters:**\n\n- \
138             `expand: Option<String>`\n- `id: &'astr`: ID of the resource to return \
139             (required)\n\n```rust,no_run\nasync fn example_workers_get() -> anyhow::Result<()> \
140             {\n    let client = rippling_api::Client::new_from_env();\n    let result: \
141             rippling_api::types::Worker = client\n        .workers()\n        .get(\n            \
142             Some(\"some-string\".to_string()),\n            \
143             \"d9797f8d-9ad6-4e08-90d7-2ec17e13471c\",\n        )\n        .await?;\n    \
144             println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
145    #[tracing::instrument]
146    pub async fn get<'a>(
147        &'a self,
148        expand: Option<String>,
149        id: &'a str,
150    ) -> Result<crate::types::Worker, crate::types::error::Error> {
151        let mut req = self.client.client.request(
152            http::Method::GET,
153            format!(
154                "{}/{}",
155                self.client.base_url,
156                "workers/{id}".replace("{id}", id)
157            ),
158        );
159        req = req.bearer_auth(&self.client.token);
160        let mut query_params = vec![];
161        if let Some(p) = expand {
162            query_params.push(("expand", p));
163        }
164
165        req = req.query(&query_params);
166        let resp = req.send().await?;
167        let status = resp.status();
168        if status.is_success() {
169            let text = resp.text().await.unwrap_or_default();
170            serde_json::from_str(&text).map_err(|err| {
171                crate::types::error::Error::from_serde_error(
172                    format_serde_error::SerdeError::new(text.to_string(), err),
173                    status,
174                )
175            })
176        } else {
177            let text = resp.text().await.unwrap_or_default();
178            Err(crate::types::error::Error::Server {
179                body: text.to_string(),
180                status,
181            })
182        }
183    }
184}