# 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 Insights API
  version: 1.0.0
extends: openapi/mx-technologies-insights-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: 10
- target: $.paths['/users/{user_guid}/accounts/{account_guid}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List insights for one account
      effect: read
      questions:
      - What financial insights has MX generated about a specific account?
      - Can I page through the insights tied to one checking account?
      instructions:
      - text: List insights for account {account} of user {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      - text: Show the tips and alerts generated for account {account} belonging to {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List all insights for a user
      effect: read
      questions:
      - What money insights does a user have across all their accounts?
      - How many insights has a user received, and can I page through them?
      instructions:
      - text: List every insight for user {user}.
        slots:
          user: path.user_guid
      - text: Show {per_page} of user {user}'s insights per page.
        slots:
          per_page: query.records_per_page
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List the categories behind an insight
      effect: read
      questions:
      - Which spending categories is a particular insight about?
      - Can I see what categories an insight references?
      instructions:
      - text: List the categories linked to insight {insight} for user {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      - text: Show which spending categories insight {insight} of {user} covers.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the accounts behind an insight
      effect: read
      questions:
      - Which of a user's accounts does a given insight refer to?
      - Can I find out what accounts triggered an insight?
      instructions:
      - text: List accounts associated with insight {insight} for user {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      - text: Show which accounts insight {insight} of {user} is based on.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}/merchants'].get
  update:
    x-apievangelist-phrasing:
      intent: List the merchants behind an insight
      effect: read
      questions:
      - Which merchants is a spending insight talking about?
      - Can I get the stores or businesses referenced by an insight?
      instructions:
      - text: List merchants tied to insight {insight} for user {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      - text: Show the merchants that insight {insight} of {user} mentions.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}/scheduled_payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled payments behind an insight
      effect: read
      questions:
      - Which upcoming bills or recurring payments does an insight refer to?
      - Can I see the scheduled payments linked to an insight about subscriptions?
      instructions:
      - text: List scheduled payments associated with insight {insight} for user {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      - text: Show the recurring payments that insight {insight} of {user} flags.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions behind an insight
      effect: read
      questions:
      - Which transactions caused a particular insight to be generated?
      - Can I drill from an insight down to the individual purchases it's about?
      instructions:
      - text: List transactions associated with insight {insight} for user {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      - text: Show the purchases behind insight {insight} of {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a single insight
      effect: read
      questions:
      - What does one specific insight say, and when was it created?
      - Can I fetch the full details of an insight by its GUID?
      instructions:
      - text: Get insight {insight} for user {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      - text: Read the attributes of insight {insight} belonging to {user}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/insights/{insight_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an insight's attributes
      effect: write
      questions:
      - How do I change the stored attributes of an insight a user received?
      - Can an existing insight be edited by its GUID?
      instructions:
      - text: Update insight {insight} for user {user} with {insight_fields}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
          insight_fields: requestBody.insight
      - text: Save changes to {user}'s insight {insight}.
        slots:
          insight: path.insight_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions/{transaction_guid}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List insights for one transaction
      effect: read
      questions:
      - Has MX generated any insights about a specific transaction?
      - Which insights mention a particular purchase?
      instructions:
      - text: List insights for transaction {transaction} of user {user}.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      - text: Show any alerts raised about transaction {transaction} for {user}.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'