API Evangelist conversational phrasing for AppConnect V3 Segments API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AppConnect V3 Segments API
  version: 1.0.0
extends: openapi/constant-contact-segments-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: 6
- target: $.paths['/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all segments
      effect: read
      questions:
      - Which segments have I built?
      - Can I sort my segments by name or last updated?
      instructions:
      - text: List all my segments.
      - text: List my segments sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment
      effect: write
      questions:
      - Can I create a segment of contacts who clicked in the last 30 days?
      - What format do segment criteria have to be in?
      instructions:
      - text: Create a segment named {name} with criteria {segment_criteria}.
        slots:
          name: requestBody.name
          segment_criteria: requestBody.segment_criteria
      - text: Build a new segment {name} using {segment_criteria}.
        slots:
          name: requestBody.name
          segment_criteria: requestBody.segment_criteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment's criteria
      effect: read
      questions:
      - What criteria define a particular segment?
      - Can I still see the details of a segment I deleted?
      instructions:
      - text: Show segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Get the criteria of segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a segment's name and criteria
      effect: write
      questions:
      - Can I change the rules that define a segment?
      - Do I have to resend the name when I only change segment criteria?
      instructions:
      - text: Update segment {segment_id} to name {name} and criteria {segment_criteria}.
        slots:
          segment_id: path.segment_id
          name: requestBody.name
          segment_criteria: requestBody.segment_criteria
      - text: Replace the criteria of segment {segment_id} with {segment_criteria}, keeping name {name}.
        slots:
          segment_id: path.segment_id
          segment_criteria: requestBody.segment_criteria
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment
      effect: destructive
      questions:
      - Is it safe to delete a segment that a scheduled campaign uses?
      - Can I remove a segment I no longer need?
      instructions:
      - text: Delete segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Remove segment {segment_id} from my account.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segment_id}/name'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a segment
      effect: write
      questions:
      - Can I just rename a segment without touching its criteria?
      - Does a segment's new name need to be unique?
      instructions:
      - text: Rename segment {segment_id} to {name}.
        slots:
          segment_id: path.segment_id
          name: requestBody.name
      - text: Give segment {segment_id} the new name {name}, criteria unchanged.
        slots:
          segment_id: path.segment_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'