# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Storefront API V1 Email API
  version: 1.0.0
extends: openapi/optimizely-email-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: 3
- target: $.paths['/api/v1/email'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the storefront email resource
      effect: read
      questions:
      - What does the storefront email endpoint return in Optimizely Configured Commerce?
      - Where do I discover the storefront email actions available?
      instructions:
      - text: Get the storefront email resource.
      - text: Fetch the email endpoint root to see its links.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/email/tellafriend'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a product to a friend
      effect: write
      questions:
      - How do I let a shopper send a product page to a friend by email?
      - Can a tell-a-friend email include a personal message and product image?
      instructions:
      - text: Send product {productId} to {friendsName} at {friendsEmailAddress} from {yourName} ({yourEmailAddress}).
        slots:
          productId: requestBody.productId
          friendsName: requestBody.friendsName
          friendsEmailAddress: requestBody.friendsEmailAddress
          yourName: requestBody.yourName
          yourEmailAddress: requestBody.yourEmailAddress
      - text: Email the product page {productUrl} to {friendsEmailAddress} with the note {yourMessage}.
        slots:
          productUrl: requestBody.productUrl
          friendsEmailAddress: requestBody.friendsEmailAddress
          yourMessage: requestBody.yourMessage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/email/contactUs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a contact-us message
      effect: write
      questions:
      - How do I submit a storefront contact-us form on a customer's behalf?
      - Can a contact-us message include a topic and phone number?
      instructions:
      - text: 'Send a contact-us message from {firstName} {lastName} at {emailAddress}: {message}.'
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          emailAddress: requestBody.emailAddress
          message: requestBody.message
      - text: Submit a contact request about {topic} with phone {phoneNumber}, routed to {emailTo}.
        slots:
          topic: requestBody.topic
          phoneNumber: requestBody.phoneNumber
          emailTo: requestBody.emailTo
      method: generated
      generated: '2026-09-26'