front_api/
teammates.rs

1use anyhow::Result;
2
3use crate::Client;
4#[derive(Clone, Debug)]
5pub struct Teammates {
6    pub client: Client,
7}
8
9impl Teammates {
10    #[doc(hidden)]
11    pub fn new(client: Client) -> Self {
12        Self { client }
13    }
14
15    #[doc = "List teammates\n\nList the teammates in the company.\n\n```rust,no_run\nasync fn \
16             example_teammates_list() -> anyhow::Result<()> {\n    let client = \
17             front_api::Client::new_from_env();\n    let result: \
18             front_api::types::ListTeammatesResponse = client.teammates().list().await?;\n    \
19             println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
20    #[tracing::instrument]
21    pub async fn list<'a>(
22        &'a self,
23    ) -> Result<crate::types::ListTeammatesResponse, crate::types::error::Error> {
24        let mut req = self.client.client.request(
25            http::Method::GET,
26            &format!("{}/{}", self.client.base_url, "teammates"),
27        );
28        req = req.bearer_auth(&self.client.token);
29        let resp = req.send().await?;
30        let status = resp.status();
31        if status.is_success() {
32            let text = resp.text().await.unwrap_or_default();
33            serde_json::from_str(&text).map_err(|err| {
34                crate::types::error::Error::from_serde_error(
35                    format_serde_error::SerdeError::new(text.to_string(), err),
36                    status,
37                )
38            })
39        } else {
40            Err(crate::types::error::Error::UnexpectedResponse(resp))
41        }
42    }
43
44    #[doc = "Get teammate\n\nFetch a teammate.\n\n**Parameters:**\n\n- `teammate_id: &'astr`: The \
45             teammate ID (required)\n\n```rust,no_run\nasync fn example_teammates_get() -> \
46             anyhow::Result<()> {\n    let client = front_api::Client::new_from_env();\n    let \
47             result: front_api::types::TeammateResponse = \
48             client.teammates().get(\"some-string\").await?;\n    println!(\"{:?}\", result);\n    \
49             Ok(())\n}\n```"]
50    #[tracing::instrument]
51    pub async fn get<'a>(
52        &'a self,
53        teammate_id: &'a str,
54    ) -> Result<crate::types::TeammateResponse, crate::types::error::Error> {
55        let mut req = self.client.client.request(
56            http::Method::GET,
57            &format!(
58                "{}/{}",
59                self.client.base_url,
60                "teammates/{teammate_id}".replace("{teammate_id}", teammate_id)
61            ),
62        );
63        req = req.bearer_auth(&self.client.token);
64        let resp = req.send().await?;
65        let status = resp.status();
66        if status.is_success() {
67            let text = resp.text().await.unwrap_or_default();
68            serde_json::from_str(&text).map_err(|err| {
69                crate::types::error::Error::from_serde_error(
70                    format_serde_error::SerdeError::new(text.to_string(), err),
71                    status,
72                )
73            })
74        } else {
75            Err(crate::types::error::Error::UnexpectedResponse(resp))
76        }
77    }
78
79    #[doc = "Update teammate\n\nUpdate a teammate.\n\n**Parameters:**\n\n- `teammate_id: &'astr`: The teammate ID (required)\n\n```rust,no_run\nasync fn example_teammates_update() -> anyhow::Result<()> {\n    let client = front_api::Client::new_from_env();\n    client\n        .teammates()\n        .update(\n            \"some-string\",\n            &serde_json::Value::String(\"some-string\".to_string()),\n        )\n        .await?;\n    Ok(())\n}\n```"]
80    #[tracing::instrument]
81    pub async fn update<'a>(
82        &'a self,
83        teammate_id: &'a str,
84        body: &crate::types::UpdateTeammate,
85    ) -> Result<(), crate::types::error::Error> {
86        let mut req = self.client.client.request(
87            http::Method::PATCH,
88            &format!(
89                "{}/{}",
90                self.client.base_url,
91                "teammates/{teammate_id}".replace("{teammate_id}", teammate_id)
92            ),
93        );
94        req = req.bearer_auth(&self.client.token);
95        req = req.json(body);
96        let resp = req.send().await?;
97        let status = resp.status();
98        if status.is_success() {
99            Ok(())
100        } else {
101            Err(crate::types::error::Error::UnexpectedResponse(resp))
102        }
103    }
104
105    #[doc = "List assigned conversations\n\nList the conversations assigned to a teammate in reverse chronological order (most recently updated first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).\n> ⚠\u{fe0f} Deprecated field included\n>\n> This endpoint returns a deprecated `last_message` field in the top-level conversation bodies listed. Please use the\n> `_links.related.last_message` field instead.\n\n\n**Parameters:**\n\n- `limit: Option<i64>`: Max number of results per page\n- `page_token: Option<String>`: Token to use to request the next page\n- `q: Option<String>`: Search query object with a property `statuses`, whose value should be a list of conversation statuses (`assigned`, `unassigned`, `archived`, or `deleted`).\n- `teammate_id: &'astr`: The teammate ID (required)\n\n```rust,no_run\nasync fn example_teammates_list_assigned_conversations() -> anyhow::Result<()> {\n    let client = front_api::Client::new_from_env();\n    let result: front_api::types::ListAssignedConversationsResponse = client\n        .teammates()\n        .list_assigned_conversations(\n            Some(4 as i64),\n            Some(\"some-string\".to_string()),\n            Some(\"some-string\".to_string()),\n            \"some-string\",\n        )\n        .await?;\n    println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
106    #[tracing::instrument]
107    pub async fn list_assigned_conversations<'a>(
108        &'a self,
109        limit: Option<i64>,
110        page_token: Option<String>,
111        q: Option<String>,
112        teammate_id: &'a str,
113    ) -> Result<crate::types::ListAssignedConversationsResponse, crate::types::error::Error> {
114        let mut req = self.client.client.request(
115            http::Method::GET,
116            &format!(
117                "{}/{}",
118                self.client.base_url,
119                "teammates/{teammate_id}/conversations".replace("{teammate_id}", teammate_id)
120            ),
121        );
122        req = req.bearer_auth(&self.client.token);
123        let mut query_params = Vec::new();
124        if let Some(p) = limit {
125            query_params.push(("limit", format!("{}", p)));
126        }
127
128        if let Some(p) = page_token {
129            query_params.push(("page_token", p));
130        }
131
132        if let Some(p) = q {
133            query_params.push(("q", p));
134        }
135
136        req = req.query(&query_params);
137        let resp = req.send().await?;
138        let status = resp.status();
139        if status.is_success() {
140            let text = resp.text().await.unwrap_or_default();
141            serde_json::from_str(&text).map_err(|err| {
142                crate::types::error::Error::from_serde_error(
143                    format_serde_error::SerdeError::new(text.to_string(), err),
144                    status,
145                )
146            })
147        } else {
148            Err(crate::types::error::Error::UnexpectedResponse(resp))
149        }
150    }
151
152    #[doc = "List teammate inboxes\n\nReturns list of inboxes the teammate has access \
153             to.\n\n**Parameters:**\n\n- `teammate_id: &'astr`: The teammate ID \
154             (required)\n\n**NOTE:** This operation is marked as \
155             deprecated.\n\n```rust,no_run\nasync fn example_teammates_list_inboxes() -> \
156             anyhow::Result<()> {\n    let client = front_api::Client::new_from_env();\n    let \
157             result: front_api::types::ListTeammateInboxesResponse =\n        \
158             client.teammates().list_inboxes(\"some-string\").await?;\n    println!(\"{:?}\", \
159             result);\n    Ok(())\n}\n```"]
160    #[tracing::instrument]
161    pub async fn list_inboxes<'a>(
162        &'a self,
163        teammate_id: &'a str,
164    ) -> Result<crate::types::ListTeammateInboxesResponse, crate::types::error::Error> {
165        let mut req = self.client.client.request(
166            http::Method::GET,
167            &format!(
168                "{}/{}",
169                self.client.base_url,
170                "teammates/{teammate_id}/inboxes".replace("{teammate_id}", teammate_id)
171            ),
172        );
173        req = req.bearer_auth(&self.client.token);
174        let resp = req.send().await?;
175        let status = resp.status();
176        if status.is_success() {
177            let text = resp.text().await.unwrap_or_default();
178            serde_json::from_str(&text).map_err(|err| {
179                crate::types::error::Error::from_serde_error(
180                    format_serde_error::SerdeError::new(text.to_string(), err),
181                    status,
182                )
183            })
184        } else {
185            Err(crate::types::error::Error::UnexpectedResponse(resp))
186        }
187    }
188}