Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online RPA API

8 actions 8 updates phrasing extends openapi/live-direct-marketing-online-rpa-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/rpa/poll'].get
$.paths['/api/rpa/job-status'].get
$.paths['/api/rpa/job-report'].post
$.paths['/api/rpa/system-report'].post
$.paths['/api/rpa/system-status'].get
$.paths['/api/rpa/task-status'].get
$.paths['/api/rpa/report'].post

OpenAPI Overlay

Raw ↑
# 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 RPA API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-rpa-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: 7
- target: $.paths['/api/rpa/poll'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll for RPA work on the legacy queue
      effect: read
      questions:
      - How does a legacy RPA bot find queued jobs or unprocessed contacts?
      - Is there any RPA work waiting right now?
      instructions:
      - text: Poll for available RPA work.
      - text: Check the legacy RPA queue for jobs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/rpa/job-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a legacy RPA job's status
      effect: read
      questions:
      - Is my RPA job ready yet?
      - Can I poll an RPA job's status by job id?
      instructions:
      - text: Check RPA job {jobId} in database {dbName}.
        slots:
          jobId: query.jobId
          dbName: query.dbName
      - text: Poll status of RPA job {jobId} on {dbName} until it is ready.
        slots:
          jobId: query.jobId
          dbName: query.dbName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/rpa/job-report'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a legacy RPA send job result
      effect: write
      questions:
      - How does a legacy RPA bot report the result of a send job?
      - Where does an RPA bot submit a single job's outcome?
      instructions:
      - text: Report the result of this RPA send job.
      - text: Submit the outcome of the finished RPA job.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/rpa/system-report'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a process-level RPA error
      effect: write
      questions:
      - Can an RPA bot report an error that isn't tied to any job?
      - Where do I log an RPA process crash?
      instructions:
      - text: Report a system-level RPA error.
      - text: Log this RPA process error that is not tied to a job.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/rpa/system-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get RPA system health
      effect: read
      questions:
      - Is the RPA system healthy, or are mailings paused?
      - Can I see RPA errors and sending account stats in one place?
      instructions:
      - text: Show RPA system health.
      - text: List RPA errors, paused mailings and account stats.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/rpa/task-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a legacy RPA mailing's status
      effect: read
      questions:
      - How many items in a legacy RPA mailing have been processed?
      - Can I check a mailing-level RPA task with its item counts?
      instructions:
      - text: Show legacy RPA status for task {taskId} in {dbName}.
        slots:
          taskId: query.taskId
          dbName: query.dbName
      - text: Get item counts for RPA mailing {taskId} on {dbName}.
        slots:
          taskId: query.taskId
          dbName: query.dbName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/rpa/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a legacy batch RPA report
      effect: write
      questions:
      - How does a legacy RPA bot submit a batch of item send results?
      - Can I report many RPA item results for one mailing at once?
      instructions:
      - text: Submit the batch RPA report for task {taskId} in {dbName}.
        slots:
          taskId: query.taskId
          dbName: query.dbName
      - text: Report item send results for legacy mailing {taskId} on {dbName}.
        slots:
          taskId: query.taskId
          dbName: query.dbName
      method: generated
      generated: '2026-10-01'