# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MX Platform managed data API
  version: 1.0.0
extends: openapi/mx-technologies-managed-data-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: 16
- target: $.paths['/managed_institutions'].get
  update:
    x-apievangelist-phrasing:
      intent: List institutions available for managed data
      effect: read
      questions:
      - Which institutions can I use when loading my own account data into MX as partner-managed members?
      - Can I page through the institutions that support partner-managed members?
      instructions:
      - text: List institutions I can use for partner-managed members.
      - text: Show page {page} of managed-data institutions, {per_page} per page.
        slots:
          page: query.page
          per_page: query.records_per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's partner-managed members
      effect: read
      questions:
      - What partner-managed members have I created for a given user?
      - Can I see only the members my own system supplies data for, not the aggregated ones?
      instructions:
      - text: List the partner-managed members for user {user}.
        slots:
          user: path.user_guid
      - text: Show every member I manage the data for under user {user}.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a partner-managed member
      effect: write
      questions:
      - How do I set up a member whose account data I push in myself instead of aggregating?
      - What institution details are needed to create a partner-managed member?
      instructions:
      - text: Create a partner-managed member for user {user} with {member}.
        slots:
          user: path.user_guid
          member: requestBody.member
      - text: Add a self-managed institution connection under user {user}.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one partner-managed member
      effect: read
      questions:
      - Can I look up the attributes of a single partner-managed member?
      - What does MX store for a member I supply data for?
      instructions:
      - text: Get partner-managed member {member} of user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show the details of my managed member {member} under user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a partner-managed member
      effect: write
      questions:
      - How do I rename or change metadata on a partner-managed member?
      - Can I edit a managed member's institution or id after creating it?
      instructions:
      - text: Update partner-managed member {member} of user {user} with {member_fields}.
        slots:
          member: path.member_guid
          user: path.user_guid
          member_fields: requestBody.member
      - text: Change the name on my managed member {member} under user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner-managed member
      effect: destructive
      questions:
      - How do I remove a member whose data I was supplying myself?
      - What does the API return after a partner-managed member is deleted?
      instructions:
      - text: Delete partner-managed member {member} of user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Remove my managed member {member} and its data from user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts under a partner-managed member
      effect: read
      questions:
      - What accounts have I loaded under a partner-managed member?
      - Can I list the self-supplied accounts for one managed member?
      instructions:
      - text: List partner-managed accounts for member {member} of user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show the accounts I manage under 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}/managed_members/{member_guid}/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an account to a partner-managed member
      effect: write
      questions:
      - How do I push a new checking or savings account into a partner-managed member?
      - What account fields must I provide when creating a partner-managed account?
      instructions:
      - text: Create a partner-managed account under member {member} of user {user} with {account}.
        slots:
          member: path.member_guid
          user: path.user_guid
          account: requestBody.account
      - text: Add a new self-supplied account to managed 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}/managed_members/{member_guid}/accounts/{account_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one partner-managed account
      effect: read
      questions:
      - Can I read back a single account I loaded as partner-managed data?
      - What balance and type details are stored on a partner-managed account?
      instructions:
      - text: Get partner-managed account {account} of member {member} for user {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      - text: Show managed account {account} under 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}/managed_members/{member_guid}/accounts/{account_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a partner-managed account
      effect: write
      questions:
      - How do I push a new balance to an account I manage in MX?
      - Can I change the name or type of a partner-managed account?
      instructions:
      - text: Apply {account_fields} to the partner-managed account {account} in member {member}, user {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          account_fields: requestBody.account
      - text: Set a new balance on my managed account {account} under member {member} for 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}/managed_members/{member_guid}/accounts/{account_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner-managed account
      effect: destructive
      questions:
      - How do I remove an account I previously loaded as partner-managed data?
      - Does deleting a partner-managed account return any body?
      instructions:
      - text: Delete partner-managed account {account} of member {member} for user {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      - text: Remove my managed account {account} from 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}/managed_members/{member_guid}/accounts/{account_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions on a partner-managed account
      effect: read
      questions:
      - What transactions have I pushed into a partner-managed account?
      - Can I limit partner-managed transactions to a date range?
      instructions:
      - text: List partner-managed transactions on account {account}, member {member}, user {user}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      - text: Show managed transactions on account {account} of member {member} for user {user} from {from_date} to {to_date}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a transaction to a partner-managed account
      effect: write
      questions:
      - How do I load a purchase or deposit into an account I manage in MX?
      - What fields does a new partner-managed transaction need?
      instructions:
      - text: Create a partner-managed transaction on account {account}, member {member}, user {user} with {transaction}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          transaction: requestBody.transaction
      - text: Record a new self-supplied transaction on managed account {account} under member {member} for 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}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one partner-managed transaction
      effect: read
      questions:
      - Can I read a single transaction I loaded into a partner-managed account?
      - What attributes does MX keep on a partner-managed transaction?
      instructions:
      - text: Get partner-managed transaction {transaction} on account {account}, member {member}, user {user}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      - text: Show managed transaction {transaction} from account {account} under member {member} for user {user}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a partner-managed transaction
      effect: write
      questions:
      - How do I correct the amount or description of a transaction I pushed in myself?
      - Can a partner-managed transaction be edited after it is created?
      instructions:
      - text: Update partner-managed transaction {transaction} on account {account}, member {member}, user {user} with {transaction_fields}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          transaction_fields: requestBody.transaction
      - text: Fix the description on managed transaction {transaction} in account {account}, member {member}, user {user}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner-managed transaction
      effect: destructive
      questions:
      - How do I remove a transaction I loaded into a partner-managed account?
      - Is a deleted partner-managed transaction gone for good?
      instructions:
      - text: Delete partner-managed transaction {transaction} on account {account}, member {member}, user {user}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      - text: Remove managed transaction {transaction} from account {account} under member {member}, user {user}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'