# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Account Event API
  version: 1.0.0
extends: openapi/strivacity-account-event-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: 5
- target: $.paths['/admin/api/v1/events/account'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer account events
      effect: read
      questions:
      - What login and registration events happened for a customer account?
      - Can I filter account events by IP address, event type or date range?
      - Which account events came from a specific application?
      instructions:
      - text: List account events for account {account}.
        slots:
          account: query.subjectAccountIds
      - text: Show account events from IP {ip} between {start} and {end}.
        slots:
          ip: query.actorIps
          start: query.startDate
          end: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/events/account/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account event
      effect: read
      questions:
      - What exactly happened in a single account event?
      - Can I open one account event by its ID?
      instructions:
      - text: Get account event {event}.
        slots:
          event: path.eventId
      - text: Show the details of customer account event {event}.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/events/descriptor'].get
  update:
    x-apievangelist-phrasing:
      intent: List account event type descriptors
      effect: read
      questions:
      - What event types can appear in the account event log?
      - Which success and failure descriptors exist for account events?
      instructions:
      - text: List the descriptors for account events.
      - text: Show every possible account event type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/events/notification'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer notification events
      effect: read
      questions:
      - Was a notification email or SMS actually delivered to a customer?
      - Can I filter notification events to only failed deliveries?
      instructions:
      - text: List notification events for account {account}.
        slots:
          account: query.accountIds
      - text: Show notification events sent to {target} that failed.
        slots:
          target: query.target
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/events/notification/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer notification event
      effect: read
      questions:
      - What happened with one specific notification that was sent?
      - Can I look up a single notification event?
      instructions:
      - text: Get notification event {event}.
        slots:
          event: path.eventId
      - text: Show delivery details for customer notification event {event}.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-10-01'