# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Employments Onboarding API
  version: 1.0.0
extends: openapi/remote-com-onboarding-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: 4
- target: $.paths['/employments/{employment_id}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new hire to self-serve onboarding
      effect: write
      questions:
      - How do I invite a new hire to fill out their own onboarding details?
      - Can I send the self-serve onboarding email once the employment is ready?
      instructions:
      - text: Send the self-serve onboarding invitation to employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Invite hire {employment_id} to complete onboarding.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/employments/{employment_id}/eligibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an eligibility questionnaire for a hire
      effect: write
      questions:
      - How do I check whether a new hire is eligible to be employed?
      - Can I open an eligibility questionnaire for an employment?
      instructions:
      - text: Create an eligibility questionnaire for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Start the eligibility check questionnaire for hire {employment_id}.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/employments/{employment_id}/eligibility/{questionnaire_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an eligibility questionnaire
      effect: read
      questions:
      - What answers were given on a hire's eligibility questionnaire?
      - How do I retrieve a specific eligibility questionnaire?
      instructions:
      - text: Show eligibility questionnaire {questionnaire_id} for employment {employment_id}.
        slots:
          questionnaire_id: path.questionnaire_id
          employment_id: path.employment_id
      - text: Get questionnaire {questionnaire_id} of hire {employment_id}.
        slots:
          questionnaire_id: path.questionnaire_id
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eor_hiring/risk_reserve/proof_of_payment'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit proof of an EOR risk reserve payment
      effect: write
      questions:
      - How do I prove we paid the risk reserve required for EOR hiring?
      - Where do I upload proof of payment for the hiring reserve?
      instructions:
      - text: Submit our risk reserve proof of payment.
      - text: Send Remote the proof that the EOR hiring reserve was paid.
      method: generated
      generated: '2026-09-26'