# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Canvas API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-canvas-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: 5
- target: $.paths['/api/canvas/{id}/flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's canvas flow
      effect: read
      questions:
      - What does the step-by-step flow of a canvas campaign look like?
      - Can I read the canvas flow definition behind a campaign?
      instructions:
      - text: Show the canvas flow for campaign {id}.
        slots:
          id: path.id
      - text: Get campaign {id}'s canvas definition.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/canvas/{id}/flow'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a campaign's canvas flow
      effect: write
      questions:
      - How do I save a redesigned canvas flow for a campaign?
      - Does saving a canvas overwrite the whole flow document?
      instructions:
      - text: Replace the canvas flow of campaign {id}.
        slots:
          id: path.id
      - text: Overwrite campaign {id}'s canvas with a new flow document.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/canvas/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-step canvas stats
      effect: read
      questions:
      - How many recipients are at each step of a canvas campaign?
      - Which canvas step are contacts dropping off at?
      instructions:
      - text: Show per-step stats for canvas {id}.
        slots:
          id: path.id
      - text: Count recipients by canvas stage for campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/canvas/{id}/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts enrolled in a canvas
      effect: read
      questions:
      - Who is enrolled in a canvas campaign right now?
      - Can I list only the contacts sitting at one canvas stage?
      instructions:
      - text: List canvas {id} enrollments at stage {stage}, page {page}, {limit} per page.
        slots:
          id: path.id
          stage: query.stage
          page: query.page
          limit: query.limit
      - text: Show page {page} of enrollments in canvas {id} for stage {stage}, limit {limit}.
        slots:
          page: query.page
          id: path.id
          stage: query.stage
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/canvas/{id}/tick'].post
  update:
    x-apievangelist-phrasing:
      intent: Advance a canvas by one orchestrator tick
      effect: write
      questions:
      - How do I manually push canvas recipients forward to their next step?
      - Does running a canvas tick send emails itself?
      instructions:
      - text: Run one orchestrator tick on canvas {id}.
        slots:
          id: path.id
      - text: Advance campaign {id}'s canvas recipients one step.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'