# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mapp Engage public Segmentation API
  version: 1.0.0
extends: openapi/mapp-segmentation-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/segmentation/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a selection plan
      effect: write
      questions:
      - How do I build a new audience segment as a selection plan?
      - What must a new selection plan contain at minimum?
      instructions:
      - text: Create a new selection plan targeting customers who opened in the last 30 days.
      - text: Save this plan JSON as a new selection plan.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a selection plan
      effect: destructive
      questions:
      - Can I undo deleting a selection plan?
      - How do I permanently remove a segment I no longer need?
      instructions:
      - text: Delete selection plan {id}.
        slots:
          id: query.id
      - text: Permanently remove segment plan {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/find'].post
  update:
    x-apievangelist-phrasing:
      intent: Search selection plans
      effect: read
      questions:
      - Which selection plans do we have, page by page?
      - Can I filter and sort the list of segments by name or status?
      instructions:
      - text: List our selection plans.
      - text: Find selection plans with names containing VIP, newest first.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/getCount'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the size of a segment
      effect: read
      questions:
      - How many contacts are in a published segment?
      - What is the latest count for a selection term?
      instructions:
      - text: Get the segment count for term {termId}.
        slots:
          termId: query.termId
      - text: Tell me how many people are in selection term {termId}.
        slots:
          termId: query.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a selection plan in full
      effect: read
      questions:
      - Can I fetch a selection plan with every node and selector setting so I can edit it?
      - What is the lossless version of a segment definition?
      instructions:
      - text: Get the full selection plan {id} including all selector configuration.
        slots:
          id: query.id
      - text: Fetch plan {id} in full so I can modify and resubmit it.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the selection plan JSON schema
      effect: read
      questions:
      - What node types and selectors can a selection plan use?
      - Where do I get the schema to validate a plan before creating it?
      instructions:
      - text: Get the selection plan JSON schema.
      - text: Show me the schema describing segment plan nodes and fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a selection plan's structure
      effect: read
      questions:
      - Can I get a lightweight summary of a segment's criteria without full configuration?
      - Is there a cheap read of a selection plan's node tree?
      instructions:
      - text: Preview the node tree of selection plan {id}.
        slots:
          id: query.id
      - text: Summarize the criteria of segment plan {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a selection plan
      effect: write
      questions:
      - How do I make a draft segment live and get a selection term ID?
      - Does publishing a selection plan validate its criteria?
      - Can I publish a segment with fast count mode enabled?
      instructions:
      - text: Publish selection plan {id}.
        slots:
          id: query.id
      - text: Publish plan {id} with fast count mode {fastCountMode}.
        slots:
          id: query.id
          fastCountMode: query.fastCountMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/triggerCount'].post
  update:
    x-apievangelist-phrasing:
      intent: Recalculate a segment count
      effect: write
      questions:
      - Can I kick off a fresh count of a segment?
      - How do I refresh the audience size of a selection term?
      instructions:
      - text: Trigger a new count for selection term {termId}.
        slots:
          termId: query.termId
      - text: Recount the audience in term {termId}.
        slots:
          termId: query.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentation/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a selection plan
      effect: write
      questions:
      - Does updating a selection plan replace the whole plan or just what I send?
      - Can I change the criteria of an existing segment?
      instructions:
      - text: Overwrite selection plan {id} with this updated plan JSON.
        slots:
          id: query.id
      - text: Update plan {id} to add an age criterion.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'