API Evangelist conversational phrasing for Mx Technologies Accounts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mx Technologies Accounts API
  version: 1.0.0
extends: openapi/mx-technologies-accounts-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: 18
- target: $.paths['/users/{user_guid}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's accounts by MX GUID
      effect: read
      questions:
      - Which bank and card accounts does a user have, looked up by their MX user GUID?
      - Can I list only a user's manual accounts on the GUID-based endpoint?
      instructions:
      - text: List all accounts for MX user GUID {user}.
        slots:
          user: path.user_guid
      - text: Show user GUID {user}'s accounts where manual is {is_manual}.
        slots:
          user: path.user_guid
          is_manual: query.is_manual
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a manual account by user GUID
      effect: write
      questions:
      - How do I add a hand-tracked account, like a cash envelope, for a user by their MX GUID?
      - Which member does a new manual account get created under on the GUID path?
      instructions:
      - text: Create manual account {account} for MX user GUID {user}.
        slots:
          account: requestBody.account
          user: path.user_guid
      - text: Add a user-entered account under the Manual Institution for user GUID {user}.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts/{account_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an account by user and account GUID
      effect: read
      questions:
      - How do I get the balance and details of one account directly under a user?
      - Can I read an account without knowing which member it belongs to?
      instructions:
      - text: Get account {account} for user {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      - text: Show the current balance and attributes of user {user}'s account {account}.
        slots:
          user: path.user_guid
          account: path.account_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts/{account_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a manually created account
      effect: destructive
      questions:
      - How do I remove an account the user created by hand?
      - Can I delete aggregated bank accounts this way, or only manual ones?
      instructions:
      - text: Delete manual account {account} for user {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      - text: Remove the hand-entered account {account} from user {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts/{account_guid}/account_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full account numbers for an account by GUID
      effect: read
      questions:
      - How do I get the full account and routing numbers for one account using its MX GUID?
      - Where can I find an account's complete number when the account listing only shows the last four?
      instructions:
      - text: List account numbers for account GUID {account} of user GUID {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      - text: Get the routing and account numbers on MX account {account} for user {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/account_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List account numbers across a member
      effect: read
      questions:
      - Can I get the account and routing numbers for every account in one bank connection at once?
      - Which account numbers were verified for a member?
      instructions:
      - text: List account numbers for member {member} of user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show every account number under bank connection {member} for user {user}, {per_page} per page.
        slots:
          member: path.member_guid
          user: path.user_guid
          per_page: query.records_per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/account_owners'].get
  update:
    x-apievangelist-phrasing:
      intent: List account owners for a member by GUID
      effect: read
      questions:
      - Who owns the accounts in a bank connection, looked up with MX GUIDs?
      - Can I get account holder names and addresses for a member on the GUID path?
      instructions:
      - text: List account owners for member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show the owner identity details on MX member {member} for user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's accounts by GUID
      effect: read
      questions:
      - Which accounts came from one specific bank connection, using MX GUIDs?
      - Can I list only the accounts a user manages themselves for a given member on the GUID path?
      instructions:
      - text: List accounts for member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show MX member {member}'s accounts for user {user} where managed by user is {managed}.
        slots:
          member: path.member_guid
          user: path.user_guid
          managed: query.member_is_managed_by_user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/accounts/{account_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an account under its member by GUID
      effect: read
      questions:
      - How do I read an account's attributes through its member using MX GUIDs?
      - Can I fetch a single account nested under a specific bank connection on the GUID endpoint?
      instructions:
      - text: Get account GUID {account} under member {member} for user {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      - text: Read the member-scoped account {account} of MX member {member}, user {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/accounts/{account_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account under its member by GUID
      effect: write
      questions:
      - How do I change an account's attributes, such as hiding it, using MX GUIDs?
      - Can I edit every field of a manual account on the GUID-based update?
      instructions:
      - text: Update account GUID {account} under member {member} for user {user} with {changes}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          changes: requestBody.account
      - text: Edit MX account {account} of member {member}, user GUID {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's accounts on the versioned API
      effect: read
      questions:
      - Which accounts does a user have when I look them up by the user ID I defined?
      - Does the versioned accounts list return full account numbers or just the last four?
      instructions:
      - text: List accounts for user {user} on API version {api_version}.
        slots:
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show my user ID {user}'s accounts for the {use_case} use case.
        slots:
          user: path.user_identifier
          use_case: query.use_case
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a manual account on the versioned API
      effect: write
      questions:
      - How do I add a manually tracked account for a user identified by my own user ID?
      - What account fields do I send to create a manual account on the versioned endpoint?
      instructions:
      - text: Create manual account {account} for user {user} on API version {api_version}.
        slots:
          account: requestBody.account
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Add a hand-tracked account {account} for my user ID {user}.
        slots:
          account: requestBody.account
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/accounts/{account_identifier}/account_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account numbers on the versioned API
      effect: read
      questions:
      - How do I get full account and routing numbers for an account identified by my own IDs?
      - Can I page through an account's numbers on the versioned endpoint?
      instructions:
      - text: List account numbers for account {account} of user {user}, API version {api_version}.
        slots:
          account: path.account_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Get routing and account numbers for my user ID {user}'s account {account}.
        slots:
          user: path.user_identifier
          account: path.account_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge duplicate accounts into one
      effect: destructive
      questions:
      - A user sees the same bank account twice; can I combine the duplicates into one?
      - What happens to the other accounts when duplicates are merged, and can it be undone?
      instructions:
      - text: 'Merge these duplicate accounts for user {user}: {accounts}.'
        slots:
          user: path.user_guid
          accounts: requestBody.account
      - text: Consolidate accounts {accounts} for user {user} on API version {api_version}, deleting the extras.
        slots:
          accounts: requestBody.account
          user: path.user_guid
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/account_owners'].get
  update:
    x-apievangelist-phrasing:
      intent: List account owners on the versioned API
      effect: read
      questions:
      - Who are the account holders in a bank connection I reference with my own member ID?
      - Can I verify account ownership details through the versioned account owners endpoint?
      instructions:
      - text: List account owners for member {member} of user {user}, API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show owner names and addresses for my user ID {user}'s connection {member}.
        slots:
          user: path.user_identifier
          member: path.member_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's accounts on the versioned API
      effect: read
      questions:
      - Which accounts belong to a bank connection when I use my own user and member IDs?
      - Can I page through a member's accounts on the versioned endpoint?
      instructions:
      - text: List accounts for member {member} of user {user}, API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show my user ID {user}'s accounts under connection {member}, page {page}.
        slots:
          user: path.user_identifier
          member: path.member_identifier
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a member account on the versioned API
      effect: read
      questions:
      - How do I read one account's details using my own user, member and account identifiers?
      - Can I look up a member account's balance on the versioned endpoint?
      instructions:
      - text: Read account {account} of member {member} for user {user}, API version {api_version}.
        slots:
          account: path.account_identifier
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show balance details for my user ID {user}'s account {account} in connection {member}.
        slots:
          user: path.user_identifier
          account: path.account_identifier
          member: path.member_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a member account on the versioned API
      effect: write
      questions:
      - How do I update an account's attributes using identifiers I defined, on the versioned API?
      - Can I edit a manual account's fields through the versioned member account update?
      instructions:
      - text: Update account {account} of member {member} for user {user} with {changes}, API version {api_version}.
        slots:
          account: path.account_identifier
          member: path.member_identifier
          user: path.user_identifier
          changes: requestBody.account
          api_version: header.Accept-Version
      - text: Change my user ID {user}'s account {account} in connection {member} to {changes}.
        slots:
          user: path.user_identifier
          account: path.account_identifier
          member: path.member_identifier
          changes: requestBody.account
      method: generated
      generated: '2026-09-26'