# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Membership Member API
  version: 1.0.0
extends: openapi/hint-health-membershipmember-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/provider/memberships/{membership_id}/members/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a member on a membership
      effect: destructive
      questions:
      - How do I cancel one person on a membership and record why?
      - Can I set a future end date when cancelling a membership member?
      instructions:
      - text: Cancel member {id} on membership {membership_id} with reason {cancellation_reason}.
        slots:
          id: path.id
          membership_id: path.membership_id
          cancellation_reason: requestBody.cancellation_reason
      - text: End member {id} of membership {membership_id} on {end_date} because of {cancellation_reason}.
        slots:
          id: path.id
          membership_id: path.membership_id
          end_date: requestBody.end_date
          cancellation_reason: requestBody.cancellation_reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members on a membership
      effect: read
      questions:
      - Who is covered under a particular membership?
      - Can I see every member attached to a family membership?
      instructions:
      - text: List the members of membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Show everyone on membership {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a patient to a membership
      effect: write
      questions:
      - Can I add a dependent to an existing membership?
      - Is it possible to give a newly added member a fixed rate per period?
      instructions:
      - text: Add patient {patient} to membership {membership_id} as a {member_type}.
        slots:
          patient: requestBody.patient
          membership_id: path.membership_id
          member_type: requestBody.member_type
      - text: Add {patient} to membership {membership_id} as {member_type} starting {start_date}.
        slots:
          patient: requestBody.patient
          membership_id: path.membership_id
          member_type: requestBody.member_type
          start_date: requestBody.start_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/members/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one membership member
      effect: read
      questions:
      - What are the details of a specific member on a membership?
      - Which member type and start date does a given membership member have?
      instructions:
      - text: Show member {id} on membership {membership_id}.
        slots:
          id: path.id
          membership_id: path.membership_id
      - text: Get the details for member {id} of membership {membership_id}.
        slots:
          id: path.id
          membership_id: path.membership_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/members/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a member from a membership
      effect: destructive
      questions:
      - Can I delete a member record that was added to the wrong membership?
      - Is deleting a membership member different from cancelling them?
      instructions:
      - text: Delete member {id} from membership {membership_id}.
        slots:
          id: path.id
          membership_id: path.membership_id
      - text: Remove the member record {id} on membership {membership_id} entirely.
        slots:
          id: path.id
          membership_id: path.membership_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/members/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a membership member
      effect: write
      questions:
      - Can I change a member's start date after they join a membership?
      - Is it possible to switch someone's member type on a membership?
      instructions:
      - text: Change member {id} on membership {membership_id} to type {member_type} for patient {patient}.
        slots:
          id: path.id
          membership_id: path.membership_id
          member_type: requestBody.member_type
          patient: requestBody.patient
      - text: Set a fixed rate of {fixed_period_rate_in_cents} cents for member {id} on membership {membership_id}.
        slots:
          fixed_period_rate_in_cents: requestBody.fixed_period_rate_in_cents
          id: path.id
          membership_id: path.membership_id
      method: generated
      generated: '2026-10-01'