API Evangelist conversational phrasing for Partner Service Businesses API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partner Service Businesses API
  version: 1.0.0
extends: openapi/explorium-businesses-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: 9
- target: $.paths['/v1/businesses/match'].post
  update:
    x-apievangelist-phrasing:
      intent: Match company names or domains to business IDs
      effect: read
      questions:
      - How do I turn a list of company names and websites into business IDs?
      - Does matching return results in the same order as the companies I send?
      instructions:
      - text: 'Match these companies to business IDs: {businesses_to_match}.'
        slots:
          businesses_to_match: requestBody.businesses_to_match
      - text: Find the business ID for each record in {businesses_to_match}.
        slots:
          businesses_to_match: requestBody.businesses_to_match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses'].post
  update:
    x-apievangelist-phrasing:
      intent: Search businesses by country, size and revenue
      effect: read
      questions:
      - Can I find companies filtered by country, employee count and revenue?
      - Which businesses match my ideal customer profile, a page at a time?
      - Can I exclude companies I already have when searching the business database?
      instructions:
      - text: Find businesses matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Search businesses with {filters}, {page_size} per page.
        slots:
          filters: requestBody.filters
          page_size: requestBody.page_size
      - text: Get the next page of business results using cursor {next_cursor}.
        slots:
          next_cursor: requestBody.next_cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch events for businesses
      effect: read
      questions:
      - What recent events, like hiring or funding news, happened at these companies?
      - Can I fetch business events within a date range?
      instructions:
      - text: Fetch {event_types} events for businesses {business_ids}.
        slots:
          event_types: requestBody.event_types
          business_ids: requestBody.business_ids
      - text: Get events for {business_ids} since {timestamp_from}.
        slots:
          business_ids: requestBody.business_ids
          timestamp_from: requestBody.timestamp_from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/autocomplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete business filter values
      effect: read
      questions:
      - What valid values can I use for a business search field, like industry?
      - Can I get suggestions as I type a company filter value?
      instructions:
      - text: Suggest values for business field {field} starting with {query}.
        slots:
          field: query.field
          query: query.query
      - text: Autocomplete business field {field} semantically for {query}.
        slots:
          field: query.field
          query: query.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Count businesses matching filters
      effect: read
      questions:
      - How many companies match my filters before I pull them?
      - Can I get statistics on the business universe for a segment?
      instructions:
      - text: Count businesses matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Get business stats for the segment {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/events/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List my business event enrollments
      effect: read
      questions:
      - Which companies am I currently monitoring for events?
      - Can I see all my business event subscriptions?
      instructions:
      - text: List my business event enrollments.
      - text: Show which businesses I'm enrolled to receive events for.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/events/enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll businesses for event monitoring
      effect: write
      questions:
      - How do I start monitoring a set of companies for events?
      - Can I subscribe to specific event types for certain businesses?
      instructions:
      - text: Enroll businesses {business_ids} for {event_types} events under key {enrollment_key}.
        slots:
          business_ids: requestBody.business_ids
          event_types: requestBody.event_types
          enrollment_key: requestBody.enrollment_key
      - text: Start monitoring {business_ids} for {event_types} with enrollment key {enrollment_key}.
        slots:
          business_ids: requestBody.business_ids
          event_types: requestBody.event_types
          enrollment_key: requestBody.enrollment_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/events/enrollments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a business event enrollment
      effect: destructive
      questions:
      - How do I stop monitoring companies for events?
      - Can I delete a business enrollment I no longer need?
      instructions:
      - text: Delete business enrollment {enrollment_id}.
        slots:
          enrollment_id: requestBody.enrollment_id
      - text: Stop business event monitoring for enrollment {enrollment_id}.
        slots:
          enrollment_id: requestBody.enrollment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/businesses/events/enrollments'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a business event enrollment
      effect: write
      questions:
      - Can I change which companies or event types an existing enrollment covers?
      - What do I send to edit a business monitoring enrollment?
      instructions:
      - text: Update business enrollment {enrollment_id} to cover {business_ids} for {event_types} with key {enrollment_key}.
        slots:
          enrollment_id: requestBody.enrollment_id
          business_ids: requestBody.business_ids
          event_types: requestBody.event_types
          enrollment_key: requestBody.enrollment_key
      - text: Change the event types on enrollment {enrollment_id} to {event_types}.
        slots:
          enrollment_id: requestBody.enrollment_id
          event_types: requestBody.event_types
      method: generated
      generated: '2026-10-01'