# 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 Offline API
  version: 1.0.0
extends: openapi/conga-agreementoffline-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: 5
- target: $.paths['/api/xauthor/v1/contracts/documents/create-offline'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new agreement from an offline document
      effect: write
      questions:
      - How do I turn a document I drafted outside the system into a new agreement?
      - Can I set the locale and description when creating an offline agreement?
      instructions:
      - text: Create a new offline agreement from document content {documentContent}.
        slots:
          documentContent: requestBody.documentContent
      - text: Create an offline agreement named {suggestedFileName} with description {description}.
        slots:
          suggestedFileName: requestBody.suggestedFileName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/documents/create-offline-multipart'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an offline agreement by file upload
      effect: write
      questions:
      - Can I upload a file directly to create a new offline agreement record?
      - How do I attach tags when creating an offline agreement from an uploaded file?
      instructions:
      - text: Upload {documentFile} as a new offline agreement.
        slots:
          documentFile: requestBody.documentFile
      - text: Create an offline agreement from file {documentFile} with contract attributes {ContractAttributes}.
        slots:
          documentFile: requestBody.documentFile
          ContractAttributes: query.ContractAttributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/documents/store-executed-multipart'].post
  update:
    x-apievangelist-phrasing:
      intent: Store an already-executed agreement
      effect: write
      questions:
      - How do I store a contract that was already signed outside the system?
      - Can I upload an executed agreement file and create its record at the same time?
      instructions:
      - text: Store executed agreement file {documentFile} as a new contract.
        slots:
          documentFile: requestBody.documentFile
      - text: Upload signed contract {documentFile} with attributes {ContractAttributes}.
        slots:
          documentFile: requestBody.documentFile
          ContractAttributes: query.ContractAttributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/import-offline'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an offline document into an existing agreement
      effect: write
      questions:
      - How do I add an externally drafted document to an agreement that already exists?
      - Can I import offline document content into a specific agreement?
      instructions:
      - text: Import offline document content {documentContent} into agreement {contractId}.
        slots:
          documentContent: requestBody.documentContent
          contractId: path.contractId
      - text: Add offline document {suggestedFileName} to existing agreement {contractId}.
        slots:
          suggestedFileName: requestBody.suggestedFileName
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/import-offline-multipart'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an offline file into an existing agreement
      effect: write
      questions:
      - Can I upload a file into an existing agreement and convert a PDF to Word?
      - How do I import an uploaded offline file into an agreement I already have?
      instructions:
      - text: Upload file {documentFile} into existing agreement {contractId}.
        slots:
          documentFile: requestBody.documentFile
          contractId: path.contractId
      - text: Import {documentFile} into agreement {contractId} converting PDF to DOCX {ConvertPdfToDocx}.
        slots:
          documentFile: requestBody.documentFile
          contractId: path.contractId
          ConvertPdfToDocx: requestBody.ConvertPdfToDocx
      method: generated
      generated: '2026-10-01'