pub struct TeamApi { /* private fields */ }
Implementations§
Source§impl TeamApi
impl TeamApi
Sourcepub fn new(config: Configuration, client: HttpClient) -> Self
pub fn new(config: Configuration, client: HttpClient) -> Self
Instantiates a new TeamApi
Sourcepub async fn create_team_member(
&self,
body: &CreateTeamMemberRequest,
) -> Result<CreateTeamMemberResponse, ApiError>
pub async fn create_team_member( &self, body: &CreateTeamMemberRequest, ) -> Result<CreateTeamMemberResponse, ApiError>
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.
Sourcepub async fn bulk_create_team_members(
&self,
body: &BulkCreateTeamMembersRequest,
) -> Result<BulkCreateTeamMembersResponse, ApiError>
pub async fn bulk_create_team_members( &self, body: &BulkCreateTeamMembersRequest, ) -> Result<BulkCreateTeamMembersResponse, ApiError>
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.
Sourcepub async fn bulk_update_team_members(
&self,
body: &BulkUpdateTeamMembersRequest,
) -> Result<BulkUpdateTeamMembersResponse, ApiError>
pub async fn bulk_update_team_members( &self, body: &BulkUpdateTeamMembersRequest, ) -> Result<BulkUpdateTeamMembersResponse, ApiError>
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.
Sourcepub async fn search_team_members(
&self,
body: &SearchTeamMembersRequest,
) -> Result<SearchTeamMembersResponse, ApiError>
pub async fn search_team_members( &self, body: &SearchTeamMembersRequest, ) -> Result<SearchTeamMembersResponse, ApiError>
Returns a paginated list of TeamMember
objects for a business.
The list can be filtered by the following:
- location IDs
status
Sourcepub async fn retrieve_team_member(
&self,
team_member_id: &str,
) -> Result<RetrieveTeamMemberResponse, ApiError>
pub async fn retrieve_team_member( &self, team_member_id: &str, ) -> Result<RetrieveTeamMemberResponse, ApiError>
Retrieves a TeamMember
object for the given TeamMember.id
.
Learn about Troubleshooting the Team API.
Sourcepub async fn update_team_member(
&self,
team_member_id: &str,
body: &UpdateTeamMemberRequest,
) -> Result<UpdateTeamMemberResponse, ApiError>
pub async fn update_team_member( &self, team_member_id: &str, body: &UpdateTeamMemberRequest, ) -> Result<UpdateTeamMemberResponse, ApiError>
Updates a single TeamMember
object.
The TeamMember
object is returned on successful updates.
Learn about Troubleshooting the Team API.
Sourcepub async fn retrieve_wage_setting(
&self,
team_member_id: &str,
) -> Result<RetrieveWageSettingResponse, ApiError>
pub async fn retrieve_wage_setting( &self, team_member_id: &str, ) -> Result<RetrieveWageSettingResponse, ApiError>
Retrieves a WageSetting
object for a team member specified by TeamMember.id
.
Learn about Troubleshooting the Team API.
Sourcepub async fn update_wage_setting(
&self,
team_member_id: &str,
body: &UpdateWageSettingRequest,
) -> Result<UpdateWageSettingResponse, ApiError>
pub async fn update_wage_setting( &self, team_member_id: &str, body: &UpdateWageSettingRequest, ) -> Result<UpdateWageSettingResponse, ApiError>
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.