# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Segments API
  version: 1.0.0
extends: openapi/omnisend-segments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments
      effect: read
      questions:
      - Which audience segments have I set up?
      - Can I sort my segments and page through them with cursors?
      instructions:
      - text: List my segments sorted by {sort} in {direction} order.
        slots:
          sort: query.sort
          direction: query.direction
      - text: List the first {limit} segments.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment
      effect: write
      questions:
      - How do I create a new segment from condition groups?
      - What does a new segment need besides a name?
      instructions:
      - text: Create segment {name} with condition groups {conditionGroups}.
        slots:
          name: requestBody.name
          conditionGroups: requestBody.conditionGroups
      - text: Build a new audience segment called {name} matching {conditionGroups}.
        slots:
          name: requestBody.name
          conditionGroups: requestBody.conditionGroups
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segments/{segmentID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment
      effect: read
      questions:
      - What conditions define a specific segment?
      - Can I look up a single segment by its ID?
      instructions:
      - text: Get segment {segmentID}.
        slots:
          segmentID: path.segmentID
      - text: Show the condition groups of segment {segmentID}.
        slots:
          segmentID: path.segmentID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segments/{segmentID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a segment
      effect: write
      questions:
      - Why does updating my segment return a conflict while it's still building?
      - Can I change the conditions of an existing segment?
      instructions:
      - text: Update segment {segmentID} with name {name} and condition groups {conditionGroups}.
        slots:
          segmentID: path.segmentID
          name: requestBody.name
          conditionGroups: requestBody.conditionGroups
      - text: Change the conditions of existing segment {segmentID} named {name} to {conditionGroups}.
        slots:
          segmentID: path.segmentID
          name: requestBody.name
          conditionGroups: requestBody.conditionGroups
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segments/{segmentID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment
      effect: destructive
      questions:
      - Can I permanently delete a segment I no longer need?
      - Why can't I delete a segment that is currently being built?
      instructions:
      - text: Delete segment {segmentID}.
        slots:
          segmentID: path.segmentID
      - text: Permanently remove segment {segmentID}.
        slots:
          segmentID: path.segmentID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segments/{segmentID}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment's contact count
      effect: read
      questions:
      - How many contacts match a segment right now?
      - Can I see statistics for one of my segments?
      instructions:
      - text: Get statistics for segment {segmentID}.
        slots:
          segmentID: path.segmentID
      - text: Count the contacts matching segment {segmentID}.
        slots:
          segmentID: path.segmentID
      method: generated
      generated: '2026-10-02'