# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform Bulk Export API
  version: 1.0.0
extends: openapi/onetrust-bulk-export-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: 7
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk exports
      effect: read
      questions:
      - What bulk exports have I run and what state are they in?
      - Do bulk exports expire after a while?
      instructions:
      - text: List my bulk exports with their status and creation date.
      - text: Show page {page} of bulk exports sorted by {sort}.
        slots:
          page: query.page
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk data export
      effect: write
      questions:
      - How do I export consent receipts in bulk for a date range?
      - Which export types and file formats can a bulk export produce?
      instructions:
      - text: Start a {exportType} bulk export from {startDate} to {endDate}.
        slots:
          exportType: requestBody.exportType
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Create bulk export {name} of type {exportType} in {exportFormat} format.
        slots:
          name: requestBody.name
          exportType: requestBody.exportType
          exportFormat: requestBody.exportFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check remaining bulk export credits
      effect: read
      questions:
      - How many bulk export credits do I have left?
      - What is my account's total bulk export credit allowance?
      instructions:
      - text: Show my bulk export credit balance.
      - text: Tell me how many export credits remain on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the progress of a bulk export
      effect: read
      questions:
      - Is my bulk export finished yet?
      - How far along is a particular export job?
      instructions:
      - text: Get the status and progress of bulk export {id}.
        slots:
          id: path.id
      - text: Check whether export {id} has completed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an unfinished bulk export
      effect: destructive
      questions:
      - How do I stop a bulk export that is still running?
      - Can I cancel an export that has already completed?
      instructions:
      - text: Cancel bulk export {id}.
        slots:
          id: path.id
      - text: Stop the in-progress export job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Get download details for a bulk export
      effect: read
      questions:
      - How do I download the file produced by a finished bulk export?
      - How long is the download token for an export valid?
      instructions:
      - text: Get the download URL and token for bulk export {id}.
        slots:
          id: path.id
      - text: Give me the file name and download link for export {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ot-insights/v1/bulk-export-jobs/{id}/download/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through download details of a large export
      effect: read
      questions:
      - My bulk export produced many files — how do I page through their download links?
      - Can I use a continuation token to fetch the next batch of export files?
      instructions:
      - text: List the paged download files for export {id}.
        slots:
          id: path.id
      - text: Fetch the next page of download files for export {id} using token {continuationToken}.
        slots:
          id: path.id
          continuationToken: query.continuationToken
      method: generated
      generated: '2026-09-26'