API Evangelist conversational phrasing for X-Author Agreement API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for X-Author Agreement API
  version: 1.0.0
extends: openapi/conga-agreement-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/xauthor/v1/contracts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agreement from X-Author
      effect: write
      questions:
      - How do I create a new agreement record while authoring in Word?
      - Can I set the account and start date when creating an agreement?
      instructions:
      - text: Create agreement {name} for account {accountName}.
        slots:
          name: requestBody.name
          accountName: requestBody.accountName
      - text: Create a new agreement {name} starting {startDate} and ending {endDate}.
        slots:
          name: requestBody.name
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/advance-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search agreements with advanced filters
      effect: read
      questions:
      - Can I search agreements with complex filter expressions and grouping?
      - How do I filter agreements by several conditions and order the results?
      instructions:
      - text: Find agreements matching advanced filters {filters}, ordered by {orderBy}.
        slots:
          filters: requestBody.filters
          orderBy: requestBody.orderBy
      - text: Run an advanced agreement search with filters {filters}, limit {limit}.
        slots:
          filters: requestBody.filters
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search agreements by keyword
      effect: read
      questions:
      - How do I find agreements that match a search term?
      - Can I page through agreement search results in X-Author?
      instructions:
      - text: Search agreements for {searchVal}.
        slots:
          searchVal: requestBody.searchVal
      - text: Find agreements matching {searchVal}, {size} per page from offset {offset}.
        slots:
          searchVal: requestBody.searchVal
          size: requestBody.size
          offset: requestBody.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/query/me'].post
  update:
    x-apievangelist-phrasing:
      intent: List agreements I own
      effect: read
      questions:
      - Which agreements am I the owner of?
      - Can I search only within agreements owned by me?
      instructions:
      - text: List the agreements owned by me.
      - text: Search my own agreements for {searchVal}.
        slots:
          searchVal: requestBody.searchVal
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/recently-viewed'].post
  update:
    x-apievangelist-phrasing:
      intent: List recently viewed agreements
      effect: read
      questions:
      - Which agreements have I opened recently?
      - Can I get my recently viewed agreements to reopen one quickly?
      instructions:
      - text: Show my recently viewed agreements.
      - text: List the last {size} agreements I viewed.
        slots:
          size: requestBody.size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agreement's details
      effect: read
      questions:
      - What are the details of a specific agreement?
      - Can I pull one agreement's record by its contract ID?
      instructions:
      - text: Get agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Show the details of agreement {contractId} for org type {OrgType}.
        slots:
          contractId: path.contractId
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/record-type'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agreement's record type
      effect: read
      questions:
      - What record type is a given agreement?
      - How do I check which record type an agreement was created with?
      instructions:
      - text: Get the record type of agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Tell me which record type agreement {contractId} uses.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'