# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Batches Batch API
  version: 1.0.0
extends: openapi/omnisend-batch-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List batch operations
      effect: read
      questions:
      - Which batch jobs did I run against the products endpoint?
      - Can I filter my batch operations by status and date range?
      instructions:
      - text: List batches for the {endpoint} endpoint.
        slots:
          endpoint: query.endpoint
      - text: List {status} batches for {endpoint} between {dateFrom} and {dateTo}.
        slots:
          status: query.status
          endpoint: query.endpoint
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      method: generated
      generated: '2026-10-02'
- target: $.paths['/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk batch operation
      effect: write
      questions:
      - How do I create or update up to 100 contacts in a single request to avoid rate limits?
      - Is a bulk import of products processed right away or asynchronously?
      instructions:
      - text: 'Start a batch {method} to {endpoint} with these items: {items}.'
        slots:
          method: requestBody.method
          endpoint: requestBody.endpoint
          items: requestBody.items
      - text: 'Bulk create these records through a batch POST to {endpoint}: {items}.'
        slots:
          endpoint: requestBody.endpoint
          items: requestBody.items
      method: generated
      generated: '2026-10-02'
- target: $.paths['/batches/{batchID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a batch
      effect: read
      questions:
      - Has the bulk batch job I submitted earlier finished processing yet?
      - Can I look up the details of one batch by its ID?
      instructions:
      - text: Check the status of batch {batchID}.
        slots:
          batchID: path.batchID
      - text: Show the summary information for batch {batchID}.
        slots:
          batchID: path.batchID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/batches/{batchID}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in a batch
      effect: read
      questions:
      - Can I see the individual records that were processed inside a batch?
      - Which items inside a batch job came back with errors?
      instructions:
      - text: List the items in batch {batchID}.
        slots:
          batchID: path.batchID
      - text: Show the per-item results for batch {batchID}.
        slots:
          batchID: path.batchID
      method: generated
      generated: '2026-10-02'