API Evangelist conversational phrasing for Hightouch Events API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hightouch Events API
  version: 1.0.0
extends: openapi/hightouch-events-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: 8
- target: $.paths['/events/contracts/{contractId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an event contract
      effect: read
      questions:
      - How do I view one event contract and its event definitions?
      - What events does a specific event contract declare?
      instructions:
      - text: Get event contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Show the event definitions in contract {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/contracts/{contractId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an event contract
      effect: write
      questions:
      - Can I change what happens to undeclared events on an existing contract?
      - How do I update the event definitions in a contract I already created?
      instructions:
      - text: Set contract {contractId} to handle undeclared events with {onUndeclaredSchema}.
        slots:
          contractId: path.contractId
          onUndeclaredSchema: requestBody.onUndeclaredSchema
      - text: Replace the events in contract {contractId} with {events}.
        slots:
          contractId: path.contractId
          events: requestBody.events
      - text: Rename event contract {contractId} to {name}.
        slots:
          contractId: path.contractId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/contracts'].get
  update:
    x-apievangelist-phrasing:
      intent: List event contracts
      effect: read
      questions:
      - Which event contracts are defined in my workspace?
      - Can I filter event contracts by name?
      instructions:
      - text: List all event contracts.
      - text: Find event contracts named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/contracts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event contract
      effect: write
      questions:
      - How do I define a new event contract to validate tracked events?
      - Can a new contract block events that aren't declared in it?
      instructions:
      - text: Create an event contract named {name}.
        slots:
          name: requestBody.name
      - text: Create event contract {name} with events {events} that treats undeclared events as {onUndeclaredSchema}.
        slots:
          name: requestBody.name
          events: requestBody.events
          onUndeclaredSchema: requestBody.onUndeclaredSchema
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/domains/{domainId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an event domain
      effect: read
      questions:
      - How do I view an event domain with its events and reusable components?
      - What components does a particular event domain define?
      instructions:
      - text: Get event domain {domainId}.
        slots:
          domainId: path.domainId
      - text: Show the events and components in domain {domainId}.
        slots:
          domainId: path.domainId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/domains/{domainId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace an event domain's events and components
      effect: write
      questions:
      - Can I replace the reusable components in an existing event domain?
      - How do I change the events defined in a domain I already set up?
      instructions:
      - text: Replace the components of domain {domainId} with {components}.
        slots:
          domainId: path.domainId
          components: requestBody.components
      - text: Update domain {domainId} to define events {events}.
        slots:
          domainId: path.domainId
          events: requestBody.events
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List event domains
      effect: read
      questions:
      - Which event domains exist in my workspace?
      - Can I search event domains by name?
      instructions:
      - text: List all event domains.
      - text: Find event domains named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event domain
      effect: write
      questions:
      - How do I set up a new event domain with shared components?
      - Can I define reusable components when I create an event domain?
      instructions:
      - text: Create an event domain named {name}.
        slots:
          name: requestBody.name
      - text: Create event domain {name} with events {events} and components {components}.
        slots:
          name: requestBody.name
          events: requestBody.events
          components: requestBody.components
      method: generated
      generated: '2026-10-01'