# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Auth API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-auth-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: 8
- target: $.paths['/api/auth/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new account
      effect: write
      questions:
      - How do I sign up for a new account?
      - Can I accept the terms and privacy versions while registering?
      instructions:
      - text: Register {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Sign up {email} with password {password} and send emails in {emailLocale}.
        slots:
          email: requestBody.email
          password: requestBody.password
          emailLocale: requestBody.emailLocale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify an email address with a token
      effect: write
      questions:
      - How do I confirm my email address after signing up?
      - What does the verification link token do?
      instructions:
      - text: Verify my email with token {token}.
        slots:
          token: query.token
      - text: Confirm the signup using verification token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/resend-verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend the verification email
      effect: write
      questions:
      - I never got the verification email, can it be sent again?
      - Can I request a new confirmation link?
      instructions:
      - text: Resend the verification email to {email}.
        slots:
          email: requestBody.email
      - text: Send {email} a fresh confirmation link.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/login'].post
  update:
    x-apievangelist-phrasing:
      intent: Log in with email and password
      effect: write
      questions:
      - How do I log in with my email and password?
      - What do I get back when I sign in?
      instructions:
      - text: Log in as {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Sign {email} in using {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/logout'].post
  update:
    x-apievangelist-phrasing:
      intent: Log out of the current session
      effect: write
      questions:
      - How do I end my session?
      - Can I sign out from the API?
      instructions:
      - text: Log me out.
      - text: End my current signed-in session.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in user
      effect: read
      questions:
      - Who am I logged in as?
      - Can I check my current session's user details?
      instructions:
      - text: Show who I'm signed in as.
      - text: Get my current session's user profile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/email-access'].post
  update:
    x-apievangelist-phrasing:
      intent: Request an email sign-in link
      effect: write
      questions:
      - Can I get access sent to my email instead of using a password?
      - Is there a passwordless email access option?
      instructions:
      - text: Request email access for my sign-in.
      - text: Send me a passwordless access email.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/email-access/consume'].post
  update:
    x-apievangelist-phrasing:
      intent: Use an email access link to sign in
      effect: write
      questions:
      - What happens when I open the email access link I received?
      - Can I redeem an emailed access code to log in?
      instructions:
      - text: Consume the email access link I received.
      - text: Redeem my emailed access code to sign in.
      method: generated
      generated: '2026-10-01'