TeamService class
URL: https://developer.squareup.com/reference/square/team-api
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.
Constructors
- TeamService({required String baseUrl, required AuthenticationService authenticationService})
Properties
- authenticationService → AuthenticationService
-
final
- baseUrl → String
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batchCreateTeamMember(
{required TeamMemberBatchUpsertRequest request, String? authToken}) → Future< Map< String, TeamMember> > - Creates multiple TeamMember objects.
-
batchUpdateTeamMember(
{required TeamMemberBatchUpsertRequest request, String? authToken}) → Future< Map< String, TeamMember> > - Updates multiple TeamMember objects.
-
createBreakTypes(
{required CreateBreakTypeRequest request, String? authToken}) → Future< BreakType> - Creates a new BreakType.
-
createShift(
{required CreateShiftRequest request, String? authToken}) → Future< Shift> - Creates a new Shift.
-
createTeamMember(
{required TeamMemberUpsertRequest request, String? authToken}) → Future< TeamMember> - Creates a single TeamMember object.
-
deleteBreakTypes(
{required String breakTypeId, String? authToken}) → Future< bool> - Deletes an existing BreakType.
-
deleteShift(
{required String shiftId, String? authToken}) → Future< bool> - Deletes a Shift.
-
getTeamMemberWages(
{required String teamMemberId, String? authToken}) → Future< TeamMemberWage> - Returns a single TeamMemberWage specified by id.
-
listBreakTypes(
{required ListBreakTypesRequest request, String? authToken}) → Future< BreakTypeResponse> - Returns a paginated list of BreakType instances for a business.
-
listTeamMemberWages(
{required ListTeamMemberWageRequest request, String? authToken}) → Future< TeamMemberWageResponse> - Returns a paginated list of TeamMemberWage instances for a business.
-
listWorkWeekConfigs(
{required SearchWorkWeekConfigRequest request, String? authToken}) → Future< WorkWeekConfigResponse> - Returns a list of WorkweekConfig instances for a business.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readBreakTypes(
{required String breakTypeId, String? authToken}) → Future< BreakType> - Returns a single BreakType specified by id.
-
readShift(
{required String shiftId, String? authToken}) → Future< Shift> - Returns a single Shift specified by id.
-
readTeamMember(
{required String teamMemberId, String? authToken}) → Future< TeamMember> - Retrieves a TeamMember object for the given TeamMember.id.
-
readWageSetting(
{required String teamMemberId, String? authToken}) → Future< WageSetting> - Retrieves a WageSetting object for a team member specified by TeamMember.id.
-
searchShift(
{required SearchShiftRequest request, String? authToken}) → Future< ShiftResponse> - Returns a paginated list of Shift records for a business.
-
searchTeamMember(
{required TeamMemberSearchRequest request, String? authToken}) → Future< TeamMemberResponse> - Returns a paginated list of TeamMember objects for a business.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateBreakTypes(
{required BreakType breakType, String? authToken}) → Future< BreakType> - Updates an existing BreakType.
-
updateShift(
{required Shift shift, String? authToken}) → Future< Shift> - Updates an existing Shift.
-
updateTeamMember(
{required TeamMember teamMember, String? authToken}) → Future< TeamMember> - Updates a single TeamMember object.
-
updateWageSetting(
{required WageSetting wageSetting, String? authToken}) → Future< WageSetting> - Creates or updates a WageSetting object.
-
updateWorkWeekConfigs(
{required WorkweekConfig config, String? authToken}) → Future< WorkweekConfig> - Updates a WorkweekConfig.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited