# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch User API
  version: 1.0.0
extends: openapi/pirsch-user-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: 9
- target: $.paths['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account details
      effect: read
      questions:
      - What account information does Pirsch have on me?
      - Which email and name are on my account?
      instructions:
      - text: Show my account details.
      - text: Get the profile of the signed-in user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/name'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my full name
      effect: write
      questions:
      - How do I change the name shown on my account?
      - Can I update my full name?
      instructions:
      - text: Change my full name to {full_name}.
        slots:
          full_name: requestBody.full_name
      - text: Set the name on my account to {full_name}.
        slots:
          full_name: requestBody.full_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my account email address
      effect: write
      questions:
      - How do I move my account to a new email address?
      - Is a confirmation code needed to change my login email?
      instructions:
      - text: Change my email to {email}.
        slots:
          email: requestBody.email
      - text: Confirm my new email {email} with code {code}.
        slots:
          email: requestBody.email
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/password'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my password
      effect: write
      questions:
      - How do I change my account password?
      - What do I need to provide to set a new password?
      instructions:
      - text: Change my password from {current_password} to {password}, confirmed as {confirm_password}.
        slots:
          current_password: requestBody.current_password
          password: requestBody.password
          confirm_password: requestBody.confirm_password
      - text: Replace current password {current_password} with {password} and confirm {confirm_password}.
        slots:
          current_password: requestBody.current_password
          password: requestBody.password
          confirm_password: requestBody.confirm_password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/language'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my interface language
      effect: write
      questions:
      - Can I switch the dashboard interface to German?
      - Which setting controls the language of my account interface?
      instructions:
      - text: Set my interface language to {language}.
        slots:
          language: requestBody.language
      - text: Switch my dashboard to {language}.
        slots:
          language: requestBody.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my default dashboard time range
      effect: write
      questions:
      - Can the dashboard open on the last 30 days by default?
      - Where do I change the default time range I see?
      instructions:
      - text: Set my default time range to {default_time_range}.
        slots:
          default_time_range: requestBody.default_time_range
      - text: Make {default_time_range} the period my dashboard opens with.
        slots:
          default_time_range: requestBody.default_time_range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/news'].get
  update:
    x-apievangelist-phrasing:
      intent: Get release news and announcements
      effect: read
      questions:
      - What's new in the latest product releases?
      - Are there any announcements I haven't seen yet?
      instructions:
      - text: Show the latest release news.
      - text: List recent product announcements for my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/news'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark news items as read
      effect: write
      questions:
      - How do I dismiss announcements I've already read?
      - Can I mark release news as read?
      instructions:
      - text: Mark news {news} as read.
        slots:
          news: requestBody.news
      - text: Dismiss the announcements {news}.
        slots:
          news: requestBody.news
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/rewards'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my affiliate referral rewards
      effect: read
      questions:
      - How much have I earned from affiliate referrals?
      - Can I see a summary of my referral rewards?
      instructions:
      - text: Show my affiliate rewards.
      - text: Summarize the referral rewards I've earned.
      method: generated
      generated: '2026-10-01'