API Evangelist conversational phrasing for Auth0 Management Event Streams API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Event Streams API
  version: 1.0.0
extends: openapi/auth0-event-streams-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['/event-streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List event streams
      effect: read
      questions:
      - Which event streams are set up in my tenant?
      - Can I page through event streams with a cursor?
      instructions:
      - text: List all my event streams.
      - text: List {take} event streams starting from cursor {from}.
        slots:
          take: query.take
          from: query.from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event stream
      effect: write
      questions:
      - How do I start streaming tenant events to a webhook or EventBridge?
      - Can I create a new event stream for user lifecycle events?
      instructions:
      - text: Create a new event stream.
      - text: Set up an event stream that sends tenant events to my webhook destination.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event stream's configuration
      effect: read
      questions:
      - What destination and subscriptions does a given event stream have?
      - Is a specific event stream enabled or disabled?
      instructions:
      - text: Show me event stream {id}.
        slots:
          id: path.id
      - text: Get the destination and status of event stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event stream
      effect: destructive
      questions:
      - How do I stop and remove an event stream permanently?
      - Can I delete an event stream I no longer need?
      instructions:
      - text: Delete event stream {id}.
        slots:
          id: path.id
      - text: Remove the event stream {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an event stream
      effect: write
      questions:
      - Can I pause an event stream without deleting it?
      - How do I change which event types a stream is subscribed to?
      instructions:
      - text: Set the status of event stream {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Change the subscriptions on stream {id} to {subscriptions}.
        slots:
          id: path.id
          subscriptions: requestBody.subscriptions
      - text: Point event stream {id} at destination {destination}.
        slots:
          id: path.id
          destination: requestBody.destination
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event stream's delivery history
      effect: read
      questions:
      - Which events failed to deliver on my event stream this week?
      - Can I filter a stream's deliveries by event type and date range?
      instructions:
      - text: Show the delivery history for event stream {id}.
        slots:
          id: path.id
      - text: List deliveries on stream {id} with status {statuses} since {date_from}.
        slots:
          id: path.id
          statuses: query.statuses
          date_from: query.date_from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}/deliveries/{event_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the delivery attempts for one event
      effect: read
      questions:
      - How many times was a specific event attempted on my stream?
      - Why did one particular event fail to reach my destination?
      instructions:
      - text: Show delivery attempts for event {event_id} on stream {id}.
        slots:
          event_id: path.event_id
          id: path.id
      - text: Get the delivery history of event {event_id} in stream {id}.
        slots:
          event_id: path.event_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}/redeliver'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeliver failed events in bulk
      effect: write
      questions:
      - My webhook was down yesterday; can I resend every failed event from that window?
      - Is it possible to redeliver only failed events of certain types?
      instructions:
      - text: Redeliver failed events on stream {id} between {date_from} and {date_to}.
        slots:
          id: path.id
          date_from: requestBody.date_from
          date_to: requestBody.date_to
      - text: Resend all failed {event_types} events on stream {id}.
        slots:
          event_types: requestBody.event_types
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}/redeliver/{event_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeliver a single failed event
      effect: write
      questions:
      - Can I retry just one event that failed to deliver?
      - How do I resend a specific event ID to my stream's destination?
      instructions:
      - text: Redeliver event {event_id} on stream {id}.
        slots:
          event_id: path.event_id
          id: path.id
      - text: Retry delivery of the single failed event {event_id} to stream {id}.
        slots:
          event_id: path.event_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-streams/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to an event stream
      effect: write
      questions:
      - How can I check that my event stream destination is receiving events?
      - Can I send a sample user.created event through a stream?
      instructions:
      - text: Send a test {event_type} event to stream {id}.
        slots:
          event_type: requestBody.event_type
          id: path.id
      - text: Push a test {event_type} event with data {data} through stream {id}.
        slots:
          event_type: requestBody.event_type
          data: requestBody.data
          id: path.id
      method: generated
      generated: '2026-10-01'