# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Contract API
  version: 1.0.0
extends: openapi/conga-contract-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/clm/v1/contracts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract record
      effect: write
      questions:
      - How do I create a new contract record in Conga CLM?
      - Which fields are required when creating a contract, and what status does it start in?
      instructions:
      - text: Create a new contract record with the name and record type I give you.
      - text: Start a contract in CLM; it should begin in Requested status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several contracts permanently
      effect: destructive
      questions:
      - Can I permanently delete a whole list of contracts at once?
      - Is bulk contract deletion reversible?
      instructions:
      - text: Permanently delete every contract in this list of IDs.
      - text: Bulk-delete the contracts I listed from CLM.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contract records
      effect: read
      questions:
      - Which contracts match a set of criteria I define?
      - Why don't canceled or in-progress contracts show up in contract search results?
      - Can I get a total count along with the matching contracts?
      instructions:
      - text: Search contracts matching {criteria}.
        slots:
          criteria: requestBody.CriteriaExpression
      - text: Query contracts returning {fields}, limit {limit}.
        slots:
          fields: requestBody.Fields
          limit: requestBody.Limit
      - text: Find contracts sorted by {sort_info} and include the total count.
        slots:
          sort_info: requestBody.SortInfo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract's details
      effect: read
      questions:
      - What are all the field values, including custom fields, on a particular contract?
      - Can I look up one contract's details by its ID?
      instructions:
      - text: Show contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Get every field of contract {contract_id}, including custom ones.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract record
      effect: write
      questions:
      - Can I change the account, owner or custom fields on an existing contract?
      - What must be included when updating a contract record?
      instructions:
      - text: Update contract {contract_id} with these field values.
        slots:
          contract_id: path.contractId
      - text: Change the record owner on contract {contract_id}.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contract permanently
      effect: destructive
      questions:
      - How do I permanently remove a single contract?
      - Does deleting one contract by ID remove it from the system for good?
      instructions:
      - text: Permanently delete contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Remove only contract {contract_id} from CLM.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/signstatus'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a contract's signature status
      effect: write
      questions:
      - Can I mark a contract as signed, declined or out for signature?
      - Which signature statuses can be recorded on a contract?
      instructions:
      - text: Set the signature status of contract {contract_id} to {sign_status}.
        slots:
          contract_id: path.contractId
          sign_status: query.signStatus
      - text: Mark contract {contract_id} as out for signature.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'