# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Square Team API version: 1.0.0 extends: openapi/square-team-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 12 - target: $.paths['/v2/team-members'].post update: x-apievangelist-phrasing: intent: Add a team member effect: write questions: - How do I add a new employee to my Square team? - What fields are required to create a team member? instructions: - text: Create team member {team_member}. slots: team_member: requestBody.team_member - text: Add a new staff member with the details in {team_member}. slots: team_member: requestBody.team_member method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/bulk-create'].post update: x-apievangelist-phrasing: intent: Add many team members at once effect: write questions: - Can I onboard a whole batch of new staff in one request? - What happens if one team member in a bulk create fails? instructions: - text: Bulk create team members {team_members}. slots: team_members: requestBody.team_members - text: Onboard all the new hires in {team_members} at once. slots: team_members: requestBody.team_members method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/bulk-update'].post update: x-apievangelist-phrasing: intent: Update many team members at once effect: write questions: - Is there a way to update many existing team members together? - Does a bulk team member update stop if one record fails? instructions: - text: Bulk update team members with {team_members}. slots: team_members: requestBody.team_members - text: Apply the changes in {team_members} to those existing staff records. slots: team_members: requestBody.team_members method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/jobs'].get update: x-apievangelist-phrasing: intent: List job titles effect: read questions: - What job titles exist in my seller account? - Which jobs are tip eligible? instructions: - text: List all jobs. - text: Show the next page of jobs after {cursor}. slots: cursor: query.cursor method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/jobs'].post update: x-apievangelist-phrasing: intent: Create a job title effect: write questions: - How do I create a new job title like Barista? - Can I mark a new job as eligible for tips? instructions: - text: Create job {job}. slots: job: requestBody.job - text: Add a new job title defined by {job} using key {idempotency_key}. slots: job: requestBody.job idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/jobs/{job_id}'].get update: x-apievangelist-phrasing: intent: Get a job effect: read questions: - What title and tip setting does a specific job have? - Can I look up one job by its ID? instructions: - text: Get job {job_id}. slots: job_id: path.job_id - text: Show details for job {job_id}. slots: job_id: path.job_id method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/jobs/{job_id}'].put update: x-apievangelist-phrasing: intent: Rename a job or change tip eligibility effect: write questions: - If I rename a job, do shifts and wages pick up the new title? - Can I turn tip eligibility off for an existing job? instructions: - text: Update job {job_id} with {job}. slots: job_id: path.job_id job: requestBody.job - text: Rename job {job_id} using the title in {job}. slots: job_id: path.job_id job: requestBody.job method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/search'].post update: x-apievangelist-phrasing: intent: Search team members effect: read questions: - Which team members are active at a given location? - Can I find who the account owner is among my staff? instructions: - text: Search team members matching {query}. slots: query: requestBody.query - text: Find active team members, returning up to {limit}. slots: limit: requestBody.limit method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/{team_member_id}'].get update: x-apievangelist-phrasing: intent: Get a team member effect: read questions: - What contact info and status does a specific team member have? - Can I fetch one employee's team profile by ID? instructions: - text: Get team member {team_member_id}. slots: team_member_id: path.team_member_id - text: Show the profile of team member {team_member_id}. slots: team_member_id: path.team_member_id method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/{team_member_id}'].put update: x-apievangelist-phrasing: intent: Update a team member effect: write questions: - How do I change a team member's email or assigned locations? - Can I deactivate a staff member by updating their status? instructions: - text: Update team member {team_member_id} with {team_member}. slots: team_member_id: path.team_member_id team_member: requestBody.team_member - text: Change the details of staff member {team_member_id} to {team_member}. slots: team_member_id: path.team_member_id team_member: requestBody.team_member method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/{team_member_id}/wage-setting'].get update: x-apievangelist-phrasing: intent: Get a team member's wage setting effect: read questions: - What jobs and pay rates are assigned to a team member? - Is a given team member marked as overtime exempt? instructions: - text: Get the wage setting for team member {team_member_id}. slots: team_member_id: path.team_member_id - text: Show job assignments and pay for {team_member_id}. slots: team_member_id: path.team_member_id method: generated generated: '2026-09-26' - target: $.paths['/v2/team-members/{team_member_id}/wage-setting'].put update: x-apievangelist-phrasing: intent: Set a team member's jobs and pay effect: write questions: - How do I give a team member a raise or a new job assignment? - Does updating a wage setting replace the whole existing setting? instructions: - text: Set the wage setting for team member {team_member_id} to {wage_setting}. slots: team_member_id: path.team_member_id wage_setting: requestBody.wage_setting - text: Replace {team_member_id}'s job assignments and pay with {wage_setting}. slots: team_member_id: path.team_member_id wage_setting: requestBody.wage_setting method: generated generated: '2026-09-26'