1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
use crate::Client;
use crate::ClientResult;
pub struct Users {
pub client: Client,
}
impl Users {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Users { client }
}
/**
* Get User Info by User ID.
*
* This function performs a `GET` to the `/users/{id}` endpoint.
*
* Retrieve the information of the user with the matching user ID.
*
* **Parameters:**
*
* * `authorization: &str` -- The OAuth2 token header.
*/
pub async fn get(&self, id: &str) -> ClientResult<crate::Response<crate::types::User>> {
let url = self.client.url(
&format!("/users/{}", crate::progenitor_support::encode_path(id),),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Suspend a user.
*
* This function performs a `DELETE` to the `/users/{id}` endpoint.
*
* Suspends a user. Does not delete the user's cards. Currently this action is not reversible.
*/
pub async fn delete(&self, id: &str) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!("/users/{}", crate::progenitor_support::encode_path(id),),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Modify Existing User.
*
* This function performs a `PATCH` to the `/users/{id}` endpoint.
*
* Modify information about a user.
*/
pub async fn patch(
&self,
id: &str,
body: &crate::types::PatchUsersRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!("/users/{}", crate::progenitor_support::encode_path(id),),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* List users.
*
* This function performs a `GET` to the `/users` endpoint.
*
* Retrieve all users of the business.
*
* **Parameters:**
*
* * `authorization: &str` -- The OAuth2 token header.
* * `start: &str` -- The ID of the last entity of the previous page, used for pagination to get the next page.
* * `page_size: f64` -- The number of results to be returned in each page. The value must be between 2 and 10,000. If not specified, the default will be 1,000.
* * `department_id: &str` -- The OAuth2 token header.
* * `location_id: &str` -- The OAuth2 token header.
*/
pub async fn get_page(
&self,
start: &str,
page_size: f64,
department_id: &str,
location_id: &str,
) -> ClientResult<crate::Response<Vec<crate::types::User>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !department_id.is_empty() {
query_args.push(("department_id".to_string(), department_id.to_string()));
}
if !location_id.is_empty() {
query_args.push(("location_id".to_string(), location_id.to_string()));
}
if !page_size.to_string().is_empty() {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !start.is_empty() {
query_args.push(("start".to_string(), start.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/users?{}", query_), None);
let resp: crate::Response<crate::types::GetUsersResponse> = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(crate::Response::new(
resp.status,
resp.headers,
resp.body.data.to_vec(),
))
}
/**
* List users.
*
* This function performs a `GET` to the `/users` endpoint.
*
* As opposed to `get`, this function returns all the pages of the request at once.
*
* Retrieve all users of the business.
*/
pub async fn get_all(
&self,
department_id: &str,
location_id: &str,
) -> ClientResult<crate::Response<Vec<crate::types::User>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !department_id.is_empty() {
query_args.push(("department_id".to_string(), department_id.to_string()));
}
if !location_id.is_empty() {
query_args.push(("location_id".to_string(), location_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/users?{}", query_), None);
let crate::Response::<crate::types::GetUsersResponse> {
mut status,
mut headers,
body,
} = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut data = body.data;
let mut page = body.page.next.to_string();
// Paginate if we should.
while !page.is_empty() {
match self
.client
.get::<crate::types::GetUsersResponse>(
page.trim_start_matches(&self.client.host),
crate::Message {
body: None,
content_type: None,
},
)
.await
{
Ok(mut resp) => {
data.append(&mut resp.body.data);
status = resp.status;
headers = resp.headers;
page = if body.page.next != page {
body.page.next.to_string()
} else {
"".to_string()
};
}
Err(e) => {
if e.to_string().contains("404 Not Found") {
page = "".to_string();
} else {
return Err(e);
}
}
}
}
// Return our response data.
Ok(crate::Response::new(status, headers, data))
}
/**
* Invite a new user.
*
* This function performs a `POST` to the `/users/deferred` endpoint.
*
* Creates an invite for the user to accept. Also optionally sets department, location, and manager.
*/
pub async fn post_deferred(
&self,
body: &crate::types::PostUsersDeferredRequest,
) -> ClientResult<crate::Response<crate::types::User>> {
let url = self.client.url("/users/deferred", None);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get status of a deferred user task.
*
* This function performs a `GET` to the `/users/deferred/status/{id}` endpoint.
*
* Gets status of a deferred task for users
*/
pub async fn get_deferred_status(
&self,
id: &str,
) -> ClientResult<crate::Response<crate::types::GetUsersDeferredStatusResponse>> {
let url = self.client.url(
&format!(
"/users/deferred/status/{}",
crate::progenitor_support::encode_path(id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}