API Evangelist conversational phrasing for Impact Jobs API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Impact Jobs API
  version: 1.0.0
extends: openapi/impact-jobs-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: 12
- target: $.paths['/Agencies/{AccountSID}/Jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an agency's scheduled jobs
      effect: read
      questions:
      - Which export jobs has my agency account scheduled on impact.com?
      - Can I see only the agency jobs created within a certain date window?
      instructions:
      - text: List every job scheduled by agency account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show agency {sid} jobs created between {after} and {before}.
        slots:
          sid: path.AccountSID
          after: query.CreatedAfter
          before: query.CreatedBefore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Jobs/{JobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an agency job's status
      effect: read
      questions:
      - Has the report export my agency queued finished yet?
      - What status is an agency job in right now — queued, completed or failed?
      instructions:
      - text: Poll the status of agency job {job} under account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Tell me whether agency job {job} has reached a terminal state.
        slots:
          job: path.JobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Jobs/{JobId}/Download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an agency job's result file
      effect: read
      questions:
      - How do I get the file an agency export job produced?
      - What happens if I try downloading an agency job's output before it completes?
      instructions:
      - text: Download the result file for agency job {job} in account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Fetch agency job {job}'s output using download mode {mode}.
        slots:
          job: path.JobId
          mode: query.Mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Jobs/{JobId}/Replay'].put
  update:
    x-apievangelist-phrasing:
      intent: Re-run an agency job
      effect: write
      questions:
      - Can my agency re-run a finished export to get fresh data for the same window?
      - Is it possible to replay an agency job that ended in error?
      instructions:
      - text: Replay agency job {job} for account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Re-run the agency export job {job} with its original parameters.
        slots:
          job: path.JobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand account's jobs
      effect: read
      questions:
      - Where can I see all the jobs my brand account has created?
      - Can I filter brand-side jobs by the date they were created?
      instructions:
      - text: List all jobs for brand account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show brand jobs in {sid} created after {after}.
        slots:
          sid: path.AccountSID
          after: query.CreatedAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Jobs/{JobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand job's status
      effect: read
      questions:
      - Is the export job on my brand account still processing?
      - What does the status object for a brand-side job contain?
      instructions:
      - text: Get the status of brand job {job} in advertiser account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Check whether advertiser job {job} is complete.
        slots:
          job: path.JobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Jobs/{JobId}/Download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a brand job's result file
      effect: read
      questions:
      - How do I download the file from a completed advertiser export?
      - Why would downloading my brand job's result return a 202 instead of the file?
      instructions:
      - text: Download the result of advertiser job {job} from account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Grab brand job {job}'s output file in {mode} mode.
        slots:
          job: path.JobId
          mode: query.Mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Jobs/{JobId}/Replay'].put
  update:
    x-apievangelist-phrasing:
      intent: Re-queue a brand job
      effect: write
      questions:
      - Can I re-queue a cancelled advertiser job to pick up additional results?
      - Is there a way to rerun a failed brand export job?
      instructions:
      - text: Re-queue advertiser job {job} in account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Replay brand job {job} so it picks up any late results.
        slots:
          job: path.JobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner account's jobs
      effect: read
      questions:
      - What jobs are on my partner account?
      - Can partners narrow their job list to a creation date range?
      instructions:
      - text: List jobs on partner account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show partner {sid} jobs created before {before}.
        slots:
          sid: path.AccountSID
          before: query.CreatedBefore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Jobs/{JobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner job's status
      effect: read
      questions:
      - Has my partner report export job completed?
      - How can a partner track progress on a queued job?
      instructions:
      - text: Retrieve the status of partner job {job} on account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Check where media partner job {job} is in processing.
        slots:
          job: path.JobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Jobs/{JobId}/Download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a partner job's results
      effect: read
      questions:
      - How long is a partner job's result file available to download?
      - Where do I download the output of a completed partner export?
      instructions:
      - text: Download results for partner job {job} on account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Pull the media partner job {job} file using mode {mode}.
        slots:
          job: path.JobId
          mode: query.Mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Jobs/{JobId}/Replay'].put
  update:
    x-apievangelist-phrasing:
      intent: Replay a partner job
      effect: write
      questions:
      - Can a partner replay a completed job to refresh the export?
      - Which partner job statuses are eligible for a replay?
      instructions:
      - text: Replay partner job {job} on account {sid}.
        slots:
          sid: path.AccountSID
          job: path.JobId
      - text: Run media partner job {job} again for the same export window.
        slots:
          job: path.JobId
      method: generated
      generated: '2026-09-26'