# 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 Payment Method API
  version: 1.0.0
extends: openapi/hint-health-payment-method-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: 5
- target: $.paths['/provider/patients/{patient_id}/payment_methods'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's payment methods
      effect: read
      questions:
      - Which cards or bank accounts does a patient have on file?
      - Can I see all payment methods saved for a patient?
      instructions:
      - text: List payment methods for patient {patient_id}.
        slots:
          patient_id: path.patient_id
      - text: Show the saved cards and bank accounts of patient {patient_id}.
        slots:
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/payment_methods'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a tokenized payment method for a patient
      effect: write
      questions:
      - How do I attach a tokenized card or bank account to a patient?
      - Do I send a Rainforest id or a Stripe id when saving a payment method?
      instructions:
      - text: Add payment method {stripe_id} to patient {patient_id}.
        slots:
          stripe_id: requestBody.stripe_id
          patient_id: path.patient_id
      - text: Save Rainforest payment method {rainforest_id} for patient {patient_id}.
        slots:
          rainforest_id: requestBody.rainforest_id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/payment_methods/setup'].post
  update:
    x-apievangelist-phrasing:
      intent: Start payment method setup for a patient
      effect: write
      questions:
      - How do I get a session key or client secret to collect a patient's card securely?
      - Can the payment setup session allow bank accounts as well as cards?
      instructions:
      - text: Create a payment setup session for patient {patient_id} with bank accounts allowed {accepts_bank} and owner {user_is_owner}.
        slots:
          patient_id: path.patient_id
          accepts_bank: requestBody.accepts_bank
          user_is_owner: requestBody.user_is_owner
      - text: Start a setup intent for patient {patient_id}, accepts_bank {accepts_bank}, user_is_owner {user_is_owner}.
        slots:
          patient_id: path.patient_id
          accepts_bank: requestBody.accepts_bank
          user_is_owner: requestBody.user_is_owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/payment_methods/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one patient payment method
      effect: read
      questions:
      - Can I look up a single saved payment method for a patient?
      - What are the details of a specific card on a patient's file?
      instructions:
      - text: Show payment method {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get details of patient {patient_id}'s payment method {id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/payment_methods/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a patient's payment method
      effect: destructive
      questions:
      - Is there a way to remove an old card from a patient's account?
      - Can I delete a saved bank account for a patient?
      instructions:
      - text: Delete payment method {id} from patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Remove saved card {id} on patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'