com.squareup.square.legacy.api.TeamApi Maven / Gradle / Ivy
package com.squareup.square.legacy.api;
import com.squareup.square.legacy.exceptions.ApiException;
import com.squareup.square.legacy.models.BulkCreateTeamMembersRequest;
import com.squareup.square.legacy.models.BulkCreateTeamMembersResponse;
import com.squareup.square.legacy.models.BulkUpdateTeamMembersRequest;
import com.squareup.square.legacy.models.BulkUpdateTeamMembersResponse;
import com.squareup.square.legacy.models.CreateJobRequest;
import com.squareup.square.legacy.models.CreateJobResponse;
import com.squareup.square.legacy.models.CreateTeamMemberRequest;
import com.squareup.square.legacy.models.CreateTeamMemberResponse;
import com.squareup.square.legacy.models.ListJobsResponse;
import com.squareup.square.legacy.models.RetrieveJobResponse;
import com.squareup.square.legacy.models.RetrieveTeamMemberResponse;
import com.squareup.square.legacy.models.RetrieveWageSettingResponse;
import com.squareup.square.legacy.models.SearchTeamMembersRequest;
import com.squareup.square.legacy.models.SearchTeamMembersResponse;
import com.squareup.square.legacy.models.UpdateJobRequest;
import com.squareup.square.legacy.models.UpdateJobResponse;
import com.squareup.square.legacy.models.UpdateTeamMemberRequest;
import com.squareup.square.legacy.models.UpdateTeamMemberResponse;
import com.squareup.square.legacy.models.UpdateWageSettingRequest;
import com.squareup.square.legacy.models.UpdateWageSettingResponse;
import java.io.IOException;
import java.util.concurrent.CompletableFuture;
/**
* This interface lists all the endpoints of the group.
* This can be overridden for the mock calls.
*/
public interface TeamApi {
/**
* 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).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTeamMemberResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
CreateTeamMemberResponse createTeamMember(final 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).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTeamMemberResponse response from the API call
*/
CompletableFuture createTeamMemberAsync(final CreateTeamMemberRequest 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).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the BulkCreateTeamMembersResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
BulkCreateTeamMembersResponse bulkCreateTeamMembers(final 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).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the BulkCreateTeamMembersResponse response from the API call
*/
CompletableFuture bulkCreateTeamMembersAsync(
final BulkCreateTeamMembersRequest 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).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the BulkUpdateTeamMembersResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
BulkUpdateTeamMembersResponse bulkUpdateTeamMembers(final 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).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the BulkUpdateTeamMembersResponse response from the API call
*/
CompletableFuture bulkUpdateTeamMembersAsync(
final BulkUpdateTeamMembersRequest body);
/**
* Lists jobs in a seller account. Results are sorted by title in ascending order.
* @param cursor Optional parameter: The pagination cursor returned by the previous call to
* this endpoint. Provide this cursor to retrieve the next page of results for your
* original request. For more information, see
* [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
* @return Returns the ListJobsResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
ListJobsResponse listJobs(final String cursor) throws ApiException, IOException;
/**
* Lists jobs in a seller account. Results are sorted by title in ascending order.
* @param cursor Optional parameter: The pagination cursor returned by the previous call to
* this endpoint. Provide this cursor to retrieve the next page of results for your
* original request. For more information, see
* [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
* @return Returns the ListJobsResponse response from the API call
*/
CompletableFuture listJobsAsync(final String cursor);
/**
* Creates a job in a seller account. A job defines a title and tip eligibility. Note that
* compensation is defined in a [job assignment]($m/JobAssignment) in a team member's wage
* setting.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateJobResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
CreateJobResponse createJob(final CreateJobRequest body) throws ApiException, IOException;
/**
* Creates a job in a seller account. A job defines a title and tip eligibility. Note that
* compensation is defined in a [job assignment]($m/JobAssignment) in a team member's wage
* setting.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateJobResponse response from the API call
*/
CompletableFuture createJobAsync(final CreateJobRequest body);
/**
* Retrieves a specified job.
* @param jobId Required parameter: The ID of the job to retrieve.
* @return Returns the RetrieveJobResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
RetrieveJobResponse retrieveJob(final String jobId) throws ApiException, IOException;
/**
* Retrieves a specified job.
* @param jobId Required parameter: The ID of the job to retrieve.
* @return Returns the RetrieveJobResponse response from the API call
*/
CompletableFuture retrieveJobAsync(final String jobId);
/**
* Updates the title or tip eligibility of a job. Changes to the title propagate to all
* `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to
* tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID.
* @param jobId Required parameter: The ID of the job to update.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the UpdateJobResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
UpdateJobResponse updateJob(final String jobId, final UpdateJobRequest body) throws ApiException, IOException;
/**
* Updates the title or tip eligibility of a job. Changes to the title propagate to all
* `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to
* tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID.
* @param jobId Required parameter: The ID of the job to update.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the UpdateJobResponse response from the API call
*/
CompletableFuture updateJobAsync(final String jobId, final UpdateJobRequest body);
/**
* Returns a paginated list of `TeamMember` objects for a business. The list can be filtered by
* location IDs, `ACTIVE` or `INACTIVE` status, or whether the team member is the Square account
* owner.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTeamMembersResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
SearchTeamMembersResponse searchTeamMembers(final SearchTeamMembersRequest body) throws ApiException, IOException;
/**
* Returns a paginated list of `TeamMember` objects for a business. The list can be filtered by
* location IDs, `ACTIVE` or `INACTIVE` status, or whether the team member is the Square account
* owner.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTeamMembersResponse response from the API call
*/
CompletableFuture searchTeamMembersAsync(final SearchTeamMembersRequest body);
/**
* 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).
* @param teamMemberId Required parameter: The ID of the team member to retrieve.
* @return Returns the RetrieveTeamMemberResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
RetrieveTeamMemberResponse retrieveTeamMember(final 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).
* @param teamMemberId Required parameter: The ID of the team member to retrieve.
* @return Returns the RetrieveTeamMemberResponse response from the API call
*/
CompletableFuture retrieveTeamMemberAsync(final String teamMemberId);
/**
* 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).
* @param teamMemberId Required parameter: The ID of the team member to update.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the UpdateTeamMemberResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
UpdateTeamMemberResponse updateTeamMember(final String teamMemberId, final 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).
* @param teamMemberId Required parameter: The ID of the team member to update.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the UpdateTeamMemberResponse response from the API call
*/
CompletableFuture updateTeamMemberAsync(
final String teamMemberId, final UpdateTeamMemberRequest body);
/**
* Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`. For more
* information, see [Troubleshooting the Team
* API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). Square
* recommends using [RetrieveTeamMember]($e/Team/RetrieveTeamMember) or
* [SearchTeamMembers]($e/Team/SearchTeamMembers) to get this information directly from the
* `TeamMember.wage_setting` field.
* @param teamMemberId Required parameter: The ID of the team member for which to retrieve the
* wage setting.
* @return Returns the RetrieveWageSettingResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
RetrieveWageSettingResponse retrieveWageSetting(final String teamMemberId) throws ApiException, IOException;
/**
* Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`. For more
* information, see [Troubleshooting the Team
* API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting). Square
* recommends using [RetrieveTeamMember]($e/Team/RetrieveTeamMember) or
* [SearchTeamMembers]($e/Team/SearchTeamMembers) to get this information directly from the
* `TeamMember.wage_setting` field.
* @param teamMemberId Required parameter: The ID of the team member for which to retrieve the
* wage setting.
* @return Returns the RetrieveWageSettingResponse response from the API call
*/
CompletableFuture retrieveWageSettingAsync(final String teamMemberId);
/**
* Creates or updates a `WageSetting` object. The object is created if a `WageSetting` with the
* specified `team_member_id` doesn't exist. Otherwise, it fully replaces the `WageSetting`
* object for the team member. The `WageSetting` is returned on a successful update. For more
* information, see [Troubleshooting the Team
* API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).
* Square recommends using [CreateTeamMember]($e/Team/CreateTeamMember) or
* [UpdateTeamMember]($e/Team/UpdateTeamMember) to manage the `TeamMember.wage_setting` field
* directly.
* @param teamMemberId Required parameter: The ID of the team member for which to update the
* `WageSetting` object.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the UpdateWageSettingResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
UpdateWageSettingResponse updateWageSetting(final String teamMemberId, final UpdateWageSettingRequest body)
throws ApiException, IOException;
/**
* Creates or updates a `WageSetting` object. The object is created if a `WageSetting` with the
* specified `team_member_id` doesn't exist. Otherwise, it fully replaces the `WageSetting`
* object for the team member. The `WageSetting` is returned on a successful update. For more
* information, see [Troubleshooting the Team
* API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).
* Square recommends using [CreateTeamMember]($e/Team/CreateTeamMember) or
* [UpdateTeamMember]($e/Team/UpdateTeamMember) to manage the `TeamMember.wage_setting` field
* directly.
* @param teamMemberId Required parameter: The ID of the team member for which to update the
* `WageSetting` object.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the UpdateWageSettingResponse response from the API call
*/
CompletableFuture updateWageSettingAsync(
final String teamMemberId, final UpdateWageSettingRequest body);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy