# 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 Authentication API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-authentication-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: 13
- 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 Live Direct Marketing account?
      - Can an AI agent bootstrap an account without setting a password?
      - Do I have to accept the terms of service when registering?
      instructions:
      - text: Register a new account for {email} with password {password}, accepting the terms {termsAccepted}.
        slots:
          email: requestBody.email
          password: requestBody.password
          termsAccepted: requestBody.termsAccepted
      - text: Sign up {email} for organization {org} with website {website}.
        slots:
          email: requestBody.email
          org: requestBody.org
          website: requestBody.website
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/verify-email'].get
  update:
    x-apievangelist-phrasing:
      intent: Confirm a signup email address
      effect: write
      questions:
      - What do I do with the token from my signup confirmation email?
      - Why is my account still pending after I confirmed my email?
      instructions:
      - text: Verify my email with token {token}.
        slots:
          token: query.token
      - text: Confirm signup token {token} and return the result as {format}.
        slots:
          token: query.token
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/signup-questionnaire'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit the signup questionnaire for approval
      effect: write
      questions:
      - My signup was not auto-activated because I used a free mailbox; what extra information do I submit?
      - Which details does the signup questionnaire ask about my company and outreach volume?
      instructions:
      - text: Submit the signup questionnaire with token {token} for company {company_name}, use case {use_case}.
        slots:
          token: requestBody.token
          company_name: requestBody.company_name
          use_case: requestBody.use_case
      - text: Send the questionnaire as {applicant_type} with contacts sourced from {contacts_source} using token {token}.
        slots:
          applicant_type: requestBody.applicant_type
          contacts_source: requestBody.contacts_source
          token: requestBody.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/otc'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a one-time sign-in code for a session
      effect: write
      questions:
      - After verifying my email I got a one-time code; how is it turned into a session?
      - How long is the one-time sign-in code valid?
      instructions:
      - text: Exchange my one-time sign-in code for a session.
      - text: Redeem the single-use code from the verification redirect.
      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:
      - Can I log in with my email and password and get access and refresh tokens?
      - Why would login return 403 even though my password is correct?
      instructions:
      - text: Log in as {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Authenticate {email} and get access tokens.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh an access token
      effect: write
      questions:
      - My access token expired; can I get a new one without logging in again?
      - What do I send to rotate my access and refresh token pair?
      instructions:
      - text: Refresh my session with refresh token {refreshToken}.
        slots:
          refreshToken: requestBody.refreshToken
      - text: Exchange refresh token {refreshToken} for a new token pair.
        slots:
          refreshToken: requestBody.refreshToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/logout'].post
  update:
    x-apievangelist-phrasing:
      intent: Log out and revoke a refresh token
      effect: destructive
      questions:
      - Can I end my session so the refresh token can no longer be used?
      - What happens to my refresh token when I log out?
      instructions:
      - text: Log out and revoke refresh token {refreshToken}.
        slots:
          refreshToken: requestBody.refreshToken
      - text: End the session for refresh token {refreshToken}.
        slots:
          refreshToken: requestBody.refreshToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/forgot-password'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a password reset email
      effect: write
      questions:
      - I forgot my password; can I have a reset link emailed to me?
      - Is there a rate limit on password reset requests?
      instructions:
      - text: Send a password reset email to {email}.
        slots:
          email: requestBody.email
      - text: Request a password reset for account {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/reset-password'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a new password with a reset token
      effect: write
      questions:
      - Once I have the reset token from my email, how do I choose a new password?
      - Can I reset my password without being logged in?
      instructions:
      - text: Reset my password to {newPassword} using token {token}.
        slots:
          newPassword: requestBody.newPassword
          token: requestBody.token
      - text: Use reset token {token} to set password {newPassword}.
        slots:
          token: requestBody.token
          newPassword: requestBody.newPassword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user profile
      effect: read
      questions:
      - What profile details are stored for the account I am signed in with?
      - Can I view my own user profile?
      instructions:
      - text: Get my user profile.
      - text: Show the profile of the signed-in user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get who I am signed in as (me alias)
      effect: read
      questions:
      - Which user am I currently authenticated as, using the short me endpoint?
      - Is there a quick whoami check for my current token?
      instructions:
      - text: Tell me who I am logged in as via the me endpoint.
      - text: Run a whoami on my current session.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/change-password'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my password
      effect: write
      questions:
      - Can I change my password while signed in if I know the current one?
      - Do I need my current password to set a new one from my account?
      instructions:
      - text: Change my password, I'll provide the current one.
      - text: Update the password on my signed-in account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/impersonate/{userId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Impersonate another user (super admin)
      effect: write
      questions:
      - As a super admin, can I sign in as another user to debug their issue?
      - Who is allowed to impersonate a user?
      instructions:
      - text: Impersonate user {userId}.
        slots:
          userId: path.userId
      - text: Sign in as user {userId} for support.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'