# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Methodfi Accounts API
  version: 1.0.0
extends: openapi/methodfi-accounts-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: 8
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts
      effect: read
      questions:
      - Can I list only the accounts that belong to one holder?
      - Which accounts are still waiting on consent?
      - How do I filter accounts by status and type?
      instructions:
      - text: List accounts for holder {holder}.
        slots:
          holder: query.holder_id
      - text: Show {status} accounts of type {type}.
        slots:
          status: query.status
          type: query.type
      - text: List accounts created between {from_date} and {to_date}.
        slots:
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account for an entity
      effect: write
      questions:
      - How do I add a bank, liability, clearing or debit card account to an entity?
      - Does a new account need exactly one of ach, liability, clearing or debit_card?
      instructions:
      - text: Create an account under API version {version}.
        slots:
          version: header.Method-Version
      - text: Add a new ACH account for an entity using idempotency key {key}.
        slots:
          key: header.Idempotency-Key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account with expanded details
      effect: read
      questions:
      - Can I fetch an account and expand related objects in the same call?
      - What does the versioned account lookup return for one account ID?
      instructions:
      - text: Get account {account} with {expand} expanded.
        slots:
          account: path.accountId
          expand: query.expand
      - text: Retrieve account {account} using API version {version}.
        slots:
          account: path.accountId
          version: header.Method-Version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account's metadata or number
      effect: write
      questions:
      - How do I change the metadata stored on an account?
      - Can I correct a liability account number after it's created?
      instructions:
      - text: Set metadata {metadata} on account {account}.
        slots:
          metadata: requestBody.metadata
          account: path.accountId
      - text: Update the liability details of account {account} to {liability}.
        slots:
          account: path.accountId
          liability: requestBody.liability
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{acc_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account (legacy unversioned path)
      effect: read
      questions:
      - Is there an older account lookup that takes acc_id without a version header?
      - Can I still read an account through the legacy acc_id endpoint?
      instructions:
      - text: Look up account {acc_id} on the legacy unversioned endpoint.
        slots:
          acc_id: path.acc_id
      - text: Fetch account {acc_id} without sending a Method-Version header.
        slots:
          acc_id: path.acc_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{acc_id}/balances'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account's real-time balance
      effect: read
      questions:
      - How do I read the live balance straight from the account's institution?
      - Can I get the latest real-time balance for one account?
      instructions:
      - text: Get the latest real-time balance for account {acc_id}.
        slots:
          acc_id: path.acc_id
      - text: Read the current balance of account {acc_id} from its institution.
        slots:
          acc_id: path.acc_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{acc_id}/payoff'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the payoff for an account
      effect: read
      questions:
      - What is the current payoff on this loan account?
      - Can I read a single payoff for an account by its acc_id?
      instructions:
      - text: Get the payoff for account {acc_id}.
        slots:
          acc_id: path.acc_id
      - text: Show what it would take to pay off account {acc_id}.
        slots:
          acc_id: path.acc_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{acc_id}/verification_sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an account via deposits or aggregator
      effect: write
      questions:
      - Can I verify an account through micro-deposits or an instant network check?
      - Which aggregators can be used to verify an account?
      instructions:
      - text: Start verifying account {acc_id} with micro-deposits.
        slots:
          acc_id: path.acc_id
      - text: Begin an aggregator-based verification for account {acc_id}.
        slots:
          acc_id: path.acc_id
      method: generated
      generated: '2026-10-01'