com.squareup.square.api

Interface TeamApi

All Known Implementing Classes:

DefaultTeamApi

public interface TeamApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
BulkCreateTeamMembersResponse	bulkCreateTeamMembers(BulkCreateTeamMembersRequest body) Creates multiple `TeamMember` objects.
CompletableFuture<BulkCreateTeamMembersResponse>	bulkCreateTeamMembersAsync(BulkCreateTeamMembersRequest body) Creates multiple `TeamMember` objects.
BulkUpdateTeamMembersResponse	bulkUpdateTeamMembers(BulkUpdateTeamMembersRequest body) Updates multiple `TeamMember` objects.
CompletableFuture<BulkUpdateTeamMembersResponse>	bulkUpdateTeamMembersAsync(BulkUpdateTeamMembersRequest body) Updates multiple `TeamMember` objects.
CreateTeamMemberResponse	createTeamMember(CreateTeamMemberRequest body) Creates a single `TeamMember` object.
CompletableFuture<CreateTeamMemberResponse>	createTeamMemberAsync(CreateTeamMemberRequest body) Creates a single `TeamMember` object.
RetrieveTeamMemberResponse	retrieveTeamMember(String teamMemberId) Retrieves a `TeamMember` object for the given `TeamMember.id`.
CompletableFuture<RetrieveTeamMemberResponse>	retrieveTeamMemberAsync(String teamMemberId) Retrieves a `TeamMember` object for the given `TeamMember.id`.
RetrieveWageSettingResponse	retrieveWageSetting(String teamMemberId) Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`.
CompletableFuture<RetrieveWageSettingResponse>	retrieveWageSettingAsync(String teamMemberId) Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`.
SearchTeamMembersResponse	searchTeamMembers(SearchTeamMembersRequest body) Returns a paginated list of `TeamMember` objects for a business.
CompletableFuture<SearchTeamMembersResponse>	searchTeamMembersAsync(SearchTeamMembersRequest body) Returns a paginated list of `TeamMember` objects for a business.
UpdateTeamMemberResponse	updateTeamMember(String teamMemberId, UpdateTeamMemberRequest body) Updates a single `TeamMember` object.
CompletableFuture<UpdateTeamMemberResponse>	updateTeamMemberAsync(String teamMemberId, UpdateTeamMemberRequest body) Updates a single `TeamMember` object.
UpdateWageSettingResponse	updateWageSetting(String teamMemberId, UpdateWageSettingRequest body) Creates or updates a `WageSetting` object.
CompletableFuture<UpdateWageSettingResponse>	updateWageSettingAsync(String teamMemberId, UpdateWageSettingRequest body) Creates or updates a `WageSetting` object.

Method Detail

createTeamMember

CreateTeamMemberResponse createTeamMember(CreateTeamMemberRequest body)
                                   throws ApiException,
                                          IOException

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).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTeamMemberResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createTeamMemberAsync

CompletableFuture<CreateTeamMemberResponse> createTeamMemberAsync(CreateTeamMemberRequest body)

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).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTeamMemberResponse response from the API call

bulkCreateTeamMembers

BulkCreateTeamMembersResponse bulkCreateTeamMembers(BulkCreateTeamMembersRequest body)
                                             throws ApiException,
                                                    IOException

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#bulk-create-team-members).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkCreateTeamMembersResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkCreateTeamMembersAsync

CompletableFuture<BulkCreateTeamMembersResponse> bulkCreateTeamMembersAsync(BulkCreateTeamMembersRequest body)

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#bulk-create-team-members).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkCreateTeamMembersResponse response from the API call

bulkUpdateTeamMembers

BulkUpdateTeamMembersResponse bulkUpdateTeamMembers(BulkUpdateTeamMembersRequest body)
                                             throws ApiException,
                                                    IOException

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#bulk-update-team-members).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpdateTeamMembersResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkUpdateTeamMembersAsync

CompletableFuture<BulkUpdateTeamMembersResponse> bulkUpdateTeamMembersAsync(BulkUpdateTeamMembersRequest body)

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#bulk-update-team-members).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpdateTeamMembersResponse response from the API call

searchTeamMembers

SearchTeamMembersResponse searchTeamMembers(SearchTeamMembersRequest body)
                                     throws ApiException,
                                            IOException

Returns a paginated list of `TeamMember` objects for a business. The list can be filtered by the following: - location IDs - `status`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTeamMembersResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchTeamMembersAsync

CompletableFuture<SearchTeamMembersResponse> searchTeamMembersAsync(SearchTeamMembersRequest body)

Returns a paginated list of `TeamMember` objects for a business. The list can be filtered by the following: - location IDs - `status`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTeamMembersResponse response from the API call

retrieveTeamMember

RetrieveTeamMemberResponse retrieveTeamMember(String teamMemberId)
                                       throws ApiException,
                                              IOException

Retrieves a `TeamMember` object for the given `TeamMember.id`. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member).

Parameters:

teamMemberId - Required parameter: The ID of the team member to retrieve.

Returns:

Returns the RetrieveTeamMemberResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveTeamMemberAsync

CompletableFuture<RetrieveTeamMemberResponse> retrieveTeamMemberAsync(String teamMemberId)

Retrieves a `TeamMember` object for the given `TeamMember.id`. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member).

Parameters:

teamMemberId - Required parameter: The ID of the team member to retrieve.

Returns:

Returns the RetrieveTeamMemberResponse response from the API call

updateTeamMember

UpdateTeamMemberResponse updateTeamMember(String teamMemberId,
                                          UpdateTeamMemberRequest body)
                                   throws ApiException,
                                          IOException

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#update-a-team-member).

Parameters:

teamMemberId - Required parameter: The ID of the team member to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateTeamMemberResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateTeamMemberAsync

CompletableFuture<UpdateTeamMemberResponse> updateTeamMemberAsync(String teamMemberId,
                                                                  UpdateTeamMemberRequest body)

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#update-a-team-member).

Parameters:

teamMemberId - Required parameter: The ID of the team member to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateTeamMemberResponse response from the API call

retrieveWageSetting

RetrieveWageSettingResponse retrieveWageSetting(String teamMemberId)
                                         throws ApiException,
                                                IOException

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#retrievewagesetting).

Parameters:

teamMemberId - Required parameter: The ID of the team member for which to retrieve the wage setting.

Returns:

Returns the RetrieveWageSettingResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveWageSettingAsync

CompletableFuture<RetrieveWageSettingResponse> retrieveWageSettingAsync(String teamMemberId)

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#retrievewagesetting).

Parameters:

teamMemberId - Required parameter: The ID of the team member for which to retrieve the wage setting.

Returns:

Returns the RetrieveWageSettingResponse response from the API call

updateWageSetting

UpdateWageSettingResponse updateWageSetting(String teamMemberId,
                                            UpdateWageSettingRequest body)
                                     throws ApiException,
                                            IOException

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#create-or-update-a-wage-setting).

Parameters:

teamMemberId - Required parameter: The ID of the team member for which to update the `WageSetting` object.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateWageSettingResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateWageSettingAsync

CompletableFuture<UpdateWageSettingResponse> updateWageSettingAsync(String teamMemberId,
                                                                    UpdateWageSettingRequest body)

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#create-or-update-a-wage-setting).

Parameters:

teamMemberId - Required parameter: The ID of the team member for which to update the `WageSetting` object.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateWageSettingResponse response from the API call