# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Sign Reports API
  version: 1.0.0
extends: openapi/conga-reports-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: 6
- target: $.paths['/v1/cs-reports/completion'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on a sender's completed packages
      effect: read
      questions:
      - Which transactions has a particular sender gotten fully signed?
      - Can I get a summarized completion report without signer and document details?
      instructions:
      - text: Get the completion report for sender {senderId}.
        slots:
          senderId: query.senderId
      - text: Run a summary completion report for sender {senderId} on packages with status {status}.
        slots:
          senderId: query.senderId
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-reports/delegation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the delegation report for a sender
      effect: read
      questions:
      - What has been delegated for the sender I'm logged in as?
      - Can I page through a delegation report for a specific sender?
      instructions:
      - text: Get the delegation report for sender {senderId}.
        slots:
          senderId: query.senderId
      - text: Show delegation report records {from} to {to}.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-reports/sender-transaction-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize transactions per sender over a period
      effect: read
      questions:
      - How many transactions did each sender send between two dates?
      - Can I get a per-sender transaction summary for last quarter?
      instructions:
      - text: Get the sender transaction summary from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Summarize sender {senderId}'s transactions since {startDate}.
        slots:
          senderId: query.senderId
          startDate: query.startDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-reports/transaction-detail/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a detail report for one transaction
      effect: read
      questions:
      - What's the full detail report for a specific signing transaction?
      - Can I pull a report on just one transaction by its ID?
      instructions:
      - text: Get the transaction detail report for {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Show the detailed report on transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-reports/transaction-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize account transactions by status
      effect: read
      questions:
      - How many transactions in the account are still in draft or sent?
      - Can I get an account-wide transaction summary for a date range?
      instructions:
      - text: Get the account transaction summary for status {status}.
        slots:
          status: query.status
      - text: Summarize all account transactions between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-reports/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my sender usage report
      effect: read
      questions:
      - How much have I used e-signature as the logged-in sender?
      - Can I export my usage report as CSV?
      instructions:
      - text: Get my sender usage report.
      - text: Download my usage report in {format} format.
        slots:
          format: header.Accept
      method: generated
      generated: '2026-10-01'