Skip to content

Latest commit

 

History

History
464 lines (348 loc) · 12.8 KB

team.md

File metadata and controls

464 lines (348 loc) · 12.8 KB
Raw

Team

team_api = client.team

Class Name

TeamApi

Methods

Create Team Member

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.

def create_team_member(body:)

Parameters

Parameter Type Tags Description
body Create Team Member Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Create Team Member Response Hash.

Example Usage

body = {
  :idempotency_key => 'idempotency-key-0',
  :team_member => {
    :reference_id => 'reference_id_1',
    :status => 'ACTIVE',
    :given_name => 'Joe',
    :family_name => 'Doe',
    :email_address => '[email protected]',
    :phone_number => '+14159283333',
    :assigned_locations => {
      :assignment_type => 'EXPLICIT_LOCATIONS',
      :location_ids => [
        'YSGH2WBKG94QZ',
        'GA2Y9HSJ8KRYT'
      ]
    }
  }
}


result = team_api.create_team_member(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Bulk Create Team Members

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.

def bulk_create_team_members(body:)

Parameters

Parameter Type Tags Description
body Bulk Create Team Members Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Bulk Create Team Members Response Hash.

Example Usage

body = {
  :team_members => {
    'idempotency-key-1' => {
      :team_member => {
        :reference_id => 'reference_id_1',
        :given_name => 'Joe',
        :family_name => 'Doe',
        :email_address => '[email protected]',
        :phone_number => '+14159283333',
        :assigned_locations => {
          :assignment_type => 'EXPLICIT_LOCATIONS',
          :location_ids => [
            'YSGH2WBKG94QZ',
            'GA2Y9HSJ8KRYT'
          ]
        }
      }
    },
    'idempotency-key-2' => {
      :team_member => {
        :reference_id => 'reference_id_2',
        :given_name => 'Jane',
        :family_name => 'Smith',
        :email_address => '[email protected]',
        :phone_number => '+14159223334',
        :assigned_locations => {
          :assignment_type => 'ALL_CURRENT_AND_FUTURE_LOCATIONS'
        }
      }
    }
  }
}


result = team_api.bulk_create_team_members(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Bulk Update Team Members

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.

def bulk_update_team_members(body:)

Parameters

Parameter Type Tags Description
body Bulk Update Team Members Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Bulk Update Team Members Response Hash.

Example Usage

body = {
  :team_members => {
    'AFMwA08kR-MIF-3Vs0OE' => {
      :team_member => {
        :reference_id => 'reference_id_2',
        :status => 'ACTIVE',
        :given_name => 'Jane',
        :family_name => 'Smith',
        :email_address => '[email protected]',
        :phone_number => '+14159223334',
        :assigned_locations => {
          :assignment_type => 'ALL_CURRENT_AND_FUTURE_LOCATIONS'
        }
      }
    },
    'fpgteZNMaf0qOK-a4t6P' => {
      :team_member => {
        :reference_id => 'reference_id_1',
        :status => 'ACTIVE',
        :given_name => 'Joe',
        :family_name => 'Doe',
        :email_address => '[email protected]',
        :phone_number => '+14159283333',
        :assigned_locations => {
          :assignment_type => 'EXPLICIT_LOCATIONS',
          :location_ids => [
            'YSGH2WBKG94QZ',
            'GA2Y9HSJ8KRYT'
          ]
        }
      }
    }
  }
}


result = team_api.bulk_update_team_members(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Search Team Members

Returns a paginated list of TeamMember objects for a business. The list can be filtered by the following:

  • location IDs
  • status
def search_team_members(body:)

Parameters

Parameter Type Tags Description
body Search Team Members Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Search Team Members Response Hash.

Example Usage

body = {
  :query => {
    :filter => {
      :location_ids => [
        '0G5P3VGACMMQZ'
      ],
      :status => 'ACTIVE'
    }
  },
  :limit => 10
}


result = team_api.search_team_members(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Team Member

Retrieves a TeamMember object for the given TeamMember.id. Learn about Troubleshooting the Team API.

def retrieve_team_member(team_member_id:)

Parameters

Parameter Type Tags Description
team_member_id String Template, Required The ID of the team member to retrieve.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Team Member Response Hash.

Example Usage

team_member_id = 'team_member_id0'


result = team_api.retrieve_team_member(team_member_id: team_member_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Team Member

Updates a single TeamMember object. The TeamMember object is returned on successful updates. Learn about Troubleshooting the Team API.

def update_team_member(team_member_id:,
                       body:)

Parameters

Parameter Type Tags Description
team_member_id String Template, Required The ID of the team member to update.
body Update Team Member Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Update Team Member Response Hash.

Example Usage

team_member_id = 'team_member_id0'

body = {
  :team_member => {
    :reference_id => 'reference_id_1',
    :status => 'ACTIVE',
    :given_name => 'Joe',
    :family_name => 'Doe',
    :email_address => '[email protected]',
    :phone_number => '+14159283333',
    :assigned_locations => {
      :assignment_type => 'EXPLICIT_LOCATIONS',
      :location_ids => [
        'YSGH2WBKG94QZ',
        'GA2Y9HSJ8KRYT'
      ]
    }
  }
}


result = team_api.update_team_member(
  team_member_id: team_member_id,
  body: body
)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Wage Setting

Retrieves a WageSetting object for a team member specified by TeamMember.id. Learn about Troubleshooting the Team API.

def retrieve_wage_setting(team_member_id:)

Parameters

Parameter Type Tags Description
team_member_id String Template, Required The ID of the team member for which to retrieve the wage setting.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Wage Setting Response Hash.

Example Usage

team_member_id = 'team_member_id0'


result = team_api.retrieve_wage_setting(team_member_id: team_member_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Wage Setting

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.

def update_wage_setting(team_member_id:,
                        body:)

Parameters

Parameter Type Tags Description
team_member_id String Template, Required The ID of the team member for which to update the WageSetting object.
body Update Wage Setting Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Update Wage Setting Response Hash.

Example Usage

team_member_id = 'team_member_id0'

body = {
  :wage_setting => {
    :job_assignments => [
      {
        :job_title => 'Manager',
        :pay_type => 'SALARY',
        :annual_rate => {
          :amount => 3000000,
          :currency => 'USD'
        },
        :weekly_hours => 40
      },
      {
        :job_title => 'Cashier',
        :pay_type => 'HOURLY',
        :hourly_rate => {
          :amount => 1200,
          :currency => 'USD'
        }
      }
    ],
    :is_overtime_exempt => true
  }
}


result = team_api.update_wage_setting(
  team_member_id: team_member_id,
  body: body
)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end