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
//! Pull employee data into accounting and payroll systems with the Team API.
//!
//! The Team API allows applications to retrieve a roster of team members registered in the Square
//! Point of Sale system, which can be useful in payroll and account contexts.
//!
//! The Team API is best used in conjunction with the Labor API, where you provide team member IDs
//! to manage shifts, breaks, and wages.
use crate::{
config::Configuration,
http::client::HttpClient,
models::{
errors::SquareApiError, BulkCreateTeamMembersRequest, BulkCreateTeamMembersResponse,
BulkUpdateTeamMembersRequest, BulkUpdateTeamMembersResponse, CreateTeamMemberRequest,
CreateTeamMemberResponse, RetrieveTeamMemberResponse, RetrieveWageSettingResponse,
SearchTeamMembersRequest, SearchTeamMembersResponse, UpdateTeamMemberRequest,
UpdateTeamMemberResponse, UpdateWageSettingRequest, UpdateWageSettingResponse,
},
SquareClient,
};
const DEFAULT_URI: &str = "/team-members";
pub struct TeamApi {
/// App config information
config: Configuration,
/// HTTP Client for requests to the Team API endpoints
http_client: HttpClient,
}
impl TeamApi {
/// Instantiates a new `TeamApi`
pub fn new(square_client: SquareClient) -> TeamApi {
TeamApi {
config: square_client.config,
http_client: square_client.http_client,
}
}
/// Creates a single `TeamMember` object.
///
/// The `TeamMember` object is returned on successful creates. You must provide the following
/// values in your request to this endpoint:
/// * `given_name`
/// * `family_name`
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn create_team_member(
&self,
body: &CreateTeamMemberRequest,
) -> Result<CreateTeamMemberResponse, SquareApiError> {
let response = self.http_client.post(&self.url(), body).await?;
response.deserialize().await
}
/// Creates multiple `TeamMember` objects.
///
/// The created `TeamMember` objects are returned on successful creates. This process is non-
/// transactional and processes as much of the request as possible. If one of the creates in the
/// request cannot be successfully processed, the request is not marked as failed, but the body
/// of the response contains explicit error information for the failed create.
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn bulk_create_team_members(
&self,
body: &BulkCreateTeamMembersRequest,
) -> Result<BulkCreateTeamMembersResponse, SquareApiError> {
let url = format!("{}/bulk-create", self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Updates multiple `TeamMember` objects.
///
/// The updated `TeamMember` objects are returned on successful updates. This process is non-
/// transactional and processes as much of the request as possible. If one of the updates in the
/// request cannot be successfully processed, the request is not marked as failed, but the body
/// of the response contains explicit error information for the failed update.
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn bulk_update_team_members(
&self,
body: &BulkUpdateTeamMembersRequest,
) -> Result<BulkUpdateTeamMembersResponse, SquareApiError> {
let url = format!("{}/bulk-update", self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Returns a paginated list of `TeamMember` objects for a business.
///
/// The list can be filtered by the following:
/// * location IDs
/// * `status`
pub async fn search_team_members(
&self,
body: &SearchTeamMembersRequest,
) -> Result<SearchTeamMembersResponse, SquareApiError> {
let url = format!("{}/search", self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Retrieves a `TeamMember` object for the given `TeamMember.id`.
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn retrieve_team_member(
&self,
team_member_id: &str,
) -> Result<RetrieveTeamMemberResponse, SquareApiError> {
let url = format!("{}/{}", self.url(), team_member_id);
let response = self.http_client.get(&url).await?;
response.deserialize().await
}
/// Updates a single `TeamMember` object.
///
/// The `TeamMember` object is returned on successful updates.
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn update_team_member(
&self,
team_member_id: &str,
body: &UpdateTeamMemberRequest,
) -> Result<UpdateTeamMemberResponse, SquareApiError> {
let url = format!("{}/{}", self.url(), team_member_id);
let response = self.http_client.put(&url, body).await?;
response.deserialize().await
}
/// Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`.
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn retrieve_wage_setting(
&self,
team_member_id: &str,
) -> Result<RetrieveWageSettingResponse, SquareApiError> {
let url = format!("{}/{}/wage-setting", self.url(), team_member_id);
let response = self.http_client.get(&url).await?;
response.deserialize().await
}
/// Creates or updates a `WageSetting` object.
///
/// The object is created if a `WageSetting` with the specified `team_member_id` does not exist.
/// Otherwise, it fully replaces the `WageSetting` object for the team member. The `WageSetting`
/// is returned on a successful update.
///
/// Learn about [Troubleshooting the Team
/// API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
pub async fn update_wage_setting(
&self,
team_member_id: &str,
body: &UpdateWageSettingRequest,
) -> Result<UpdateWageSettingResponse, SquareApiError> {
let url = format!("{}/{}/wage-setting", self.url(), team_member_id);
let response = self.http_client.put(&url, body).await?;
response.deserialize().await
}
/// Constructs the basic entity URL including domain and entity path. Any additional path
/// elements (e.g. path parameters) will need to be appended to this URL.
fn url(&self) -> String {
format!("{}{}", &self.config.get_base_url(), DEFAULT_URI)
}
}