API Evangelist conversational phrasing for Mx Technologies spending plan 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 spending plan API
  version: 1.0.0
extends: openapi/mx-technologies-spending-plan-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: 15
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List line items in a spending plan
      effect: read
      questions:
      - What planned expenses and income items are in a user's current spending plan period?
      - Can I see every iteration item a spending plan contains, page by page?
      instructions:
      - text: List the iteration items in spending plan {plan} for user {user}.
        slots:
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Show all planned line items for user {user}'s spending plan {plan}, {per_page} per page.
        slots:
          user: path.user_guid
          plan: path.spending_plan_guid
          per_page: query.records_per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a planned item to a spending plan
      effect: write
      questions:
      - How do I add a planned amount for a category, like groceries, to a user's spending plan?
      - Can a spending plan item be tied to a scheduled payment instead of a category?
      instructions:
      - text: Add a {amount} planned item for category {category} to spending plan {plan} of user {user}.
        slots:
          amount: requestBody.planned_amount
          category: requestBody.category_guid
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Create a {item_type} item of {amount} in user {user}'s spending plan {plan}.
        slots:
          item_type: requestBody.item_type
          amount: requestBody.planned_amount
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's spending plans
      effect: read
      questions:
      - Does this user already have a spending plan set up?
      - Which spending plans exist for a user?
      instructions:
      - text: List spending plans for user {user}.
        slots:
          user: path.user_guid
      - text: Show every spending plan user {user} has, page {page}.
        slots:
          user: path.user_guid
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a spending plan for a user
      effect: write
      questions:
      - How do I start a new spending plan for someone?
      - Can I set up a monthly spending plan for a user with one call?
      instructions:
      - text: Create a spending plan for user {user}.
        slots:
          user: path.user_guid
      - text: Start a new spending plan on user {user}'s profile.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an account attached to a spending plan
      effect: read
      questions:
      - How do I see the details of one account included in a user's spending plan?
      - What does a spending plan account record contain?
      instructions:
      - text: Get spending plan account {plan_account} in plan {plan} for user {user}.
        slots:
          plan_account: path.spending_plan_account_guid
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Read the linked account {plan_account} of user {user}'s spending plan {plan}.
        slots:
          plan_account: path.spending_plan_account_guid
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an account from a spending plan
      effect: destructive
      questions:
      - How do I drop an account out of a user's spending plan?
      - Can I stop a spending plan from counting a particular account?
      instructions:
      - text: Delete spending plan account {plan_account} from plan {plan} for user {user}.
        slots:
          plan_account: path.spending_plan_account_guid
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Remove account {plan_account} from user {user}'s spending plan {plan}.
        slots:
          plan_account: path.spending_plan_account_guid
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one spending plan line item
      effect: read
      questions:
      - How much was planned for a single line item in a spending plan?
      - Can I look up one spending plan iteration item by its GUID?
      instructions:
      - text: Get iteration item {item} in spending plan {plan} for user {user}.
        slots:
          item: path.iteration_item_guid
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Show the planned amount on line item {item} of user {user}'s plan {plan}.
        slots:
          item: path.iteration_item_guid
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a planned amount in a spending plan
      effect: write
      questions:
      - How do I raise or lower the planned amount on an existing spending plan item?
      - Can I move an existing plan item to a different category?
      instructions:
      - text: Set line item {item} in spending plan {plan} for user {user} to {amount}.
        slots:
          item: path.iteration_item_guid
          plan: path.spending_plan_guid
          user: path.user_guid
          amount: requestBody.planned_amount
      - text: Update user {user}'s plan item {item} in plan {plan} to {amount} under category {category}.
        slots:
          user: path.user_guid
          item: path.iteration_item_guid
          plan: path.spending_plan_guid
          amount: requestBody.planned_amount
          category: requestBody.category_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a line item from a spending plan
      effect: destructive
      questions:
      - How do I take a planned expense out of a user's spending plan?
      - Can I remove a single iteration item without deleting the whole plan?
      instructions:
      - text: Delete iteration item {item} from spending plan {plan} for user {user}.
        slots:
          item: path.iteration_item_guid
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Remove line item {item} from user {user}'s plan {plan}.
        slots:
          item: path.iteration_item_guid
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a user's spending plan
      effect: read
      questions:
      - How do I retrieve the settings of a specific spending plan?
      - What attributes does MX return for one spending plan?
      instructions:
      - text: Get spending plan {plan} for user {user}.
        slots:
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Read the attributes of user {user}'s spending plan {plan}.
        slots:
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's spending plan
      effect: destructive
      questions:
      - How do I get rid of a user's entire spending plan?
      - Can a user throw away their spending plan and start over?
      instructions:
      - text: Delete spending plan {plan} for user {user}.
        slots:
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Remove user {user}'s whole spending plan {plan}.
        slots:
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts included in a spending plan
      effect: read
      questions:
      - Which of a user's accounts feed into their spending plan?
      - Can I list all spending plan accounts for one plan?
      instructions:
      - text: List the accounts in spending plan {plan} for user {user}.
        slots:
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Show which accounts user {user}'s plan {plan} tracks.
        slots:
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the periods of a spending plan
      effect: read
      questions:
      - How do I see past and present periods of a user's spending plan?
      - Can I list every iteration a spending plan has gone through?
      instructions:
      - text: List iterations of spending plan {plan} for user {user}.
        slots:
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Show the history of periods in user {user}'s spending plan {plan}.
        slots:
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the current spending plan period
      effect: read
      questions:
      - Where does a user stand in this month's spending plan?
      - How do I fetch the active iteration of a spending plan?
      instructions:
      - text: Get the current iteration of spending plan {plan} for user {user}.
        slots:
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Show this period's numbers for user {user}'s plan {plan}.
        slots:
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a spending plan period by number
      effect: read
      questions:
      - Can I look back at a specific earlier period of a spending plan by its iteration number?
      - How did a user do in iteration 3 of their spending plan?
      instructions:
      - text: Get iteration {number} of spending plan {plan} for user {user}.
        slots:
          number: path.iteration_number
          plan: path.spending_plan_guid
          user: path.user_guid
      - text: Show period number {number} from user {user}'s plan {plan}.
        slots:
          number: path.iteration_number
          user: path.user_guid
          plan: path.spending_plan_guid
      method: generated
      generated: '2026-09-26'