# 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 Notifications API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-notifications-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: 10
- target: $.paths['/api/notifications/push/public-key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Web Push VAPID public key
      effect: read
      questions:
      - What VAPID public key do I need to subscribe a browser to push notifications?
      - Where do I get the key for setting up Web Push?
      instructions:
      - text: Get the tenant VAPID public key for Web Push.
      - text: Fetch the push notification public key.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/push/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a browser for push notifications
      effect: write
      questions:
      - How do I turn on browser push notifications for my account?
      - Can I register a Web Push subscription with an expiration time?
      instructions:
      - text: Register push subscription endpoint {endpoint} with keys {keys}.
        slots:
          endpoint: requestBody.endpoint
          keys: requestBody.keys
      - text: Subscribe browser {user-agent} to push at {endpoint} using keys {keys}.
        slots:
          user-agent: header.user-agent
          endpoint: requestBody.endpoint
          keys: requestBody.keys
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/push/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a browser push subscription
      effect: destructive
      questions:
      - How do I stop push notifications in a browser?
      - Can I unregister one Web Push subscription?
      instructions:
      - text: Unsubscribe push endpoint {endpoint}.
        slots:
          endpoint: requestBody.endpoint
      - text: Remove the Web Push subscription at {endpoint}.
        slots:
          endpoint: requestBody.endpoint
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notifications
      effect: read
      questions:
      - What notifications do I have?
      - Can I filter notifications by type or include dismissed ones?
      instructions:
      - text: List my notifications of type {type}.
        slots:
          type: query.type
      - text: Show page {page} of notifications with dismissed={dismissed}, {pageSize} per page.
        slots:
          page: query.page
          dismissed: query.dismissed
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/unread-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my unread notification count
      effect: read
      questions:
      - How many unread notifications do I have?
      - What number should the notification badge show?
      instructions:
      - text: Get my unread notification count.
      - text: Tell me how many notifications are unread.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/read-all'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark all notifications as read
      effect: write
      questions:
      - Can I clear every unread notification at once?
      - How do I mark everything in my notifications as read?
      instructions:
      - text: Mark all my notifications as read.
      - text: Clear my unread notification badge.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/{id}/read'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark one notification as read
      effect: write
      questions:
      - How do I mark a single notification as read?
      - Can I acknowledge just one notification?
      instructions:
      - text: Mark notification {id} as read.
        slots:
          id: path.id
      - text: Set notification {id} to read.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/{id}/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss one notification
      effect: write
      questions:
      - Can I hide one notification from the widget?
      - How do I dismiss a specific notification?
      instructions:
      - text: Dismiss notification {id}.
        slots:
          id: path.id
      - text: Hide notification {id} from my widget.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/dismiss-all'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss all my notifications
      effect: write
      questions:
      - How do I hide every notification from the widget in one go?
      - Can I dismiss all my notifications at once?
      instructions:
      - text: Dismiss all my notifications.
      - text: Hide every notification from my widget.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/notifications/self-note'].post
  update:
    x-apievangelist-phrasing:
      intent: Leave myself a note as a notification
      effect: write
      questions:
      - Can an agent post a reminder note into my notifications?
      - How do I create a self-note that shows up as a notification?
      instructions:
      - text: Create a self-note titled {title} saying {message}.
        slots:
          title: requestBody.title
          message: requestBody.message
      - text: 'Remind me with a notification {title}: {message}.'
        slots:
          title: requestBody.title
          message: requestBody.message
      method: generated
      generated: '2026-10-01'