# 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 API
  version: 1.0.0
extends: openapi/conga-sign-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: 12
- target: $.paths['/api/clm/v1/sign/esignatures/wetsign/{transactionId}/end'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish a CLM wet signature and attach it to the contract
      effect: write
      questions:
      - Once a contract has been signed on paper, can I close out the wet signature in CLM and attach the scanned copy to the agreement?
      - What does ending a wet signature flow on the contracts side do with the signed document I upload?
      instructions:
      - text: End CLM wet signature transaction {transactionId} and attach the signed copy to its contract.
        slots:
          transactionId: path.transactionId
      - text: Close the contract-side wet signature {transactionId} using the scanned file {file}.
        slots:
          transactionId: path.transactionId
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an eSignature envelope for documents
      effect: write
      questions:
      - How do I send contract documents out for electronic signature from Conga?
      - Can one envelope go to recipients with CC and BCC copies and an expiration date?
      - Which eSignature service gets the envelope when I pick a sign provider type?
      instructions:
      - text: Create an eSignature envelope for documents {DocumentIds} addressed to {Recipients}.
        slots:
          DocumentIds: requestBody.DocumentIds
          Recipients: requestBody.Recipients
      - text: Send documents {DocumentIds} to {Recipients} for signature through {signProviderType}, expiring after {Expiration}.
        slots:
          DocumentIds: requestBody.DocumentIds
          Recipients: requestBody.Recipients
          signProviderType: query.signProviderType
          Expiration: requestBody.Expiration
      - text: Build a password-protected signing envelope for record {ObjectId} with documents {DocumentIds} and signers {Recipients}.
        slots:
          ObjectId: requestBody.ObjectId
          DocumentIds: requestBody.DocumentIds
          Recipients: requestBody.Recipients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/eventlogs'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through all eSignature event logs
      effect: read
      questions:
      - Where can I see the full log of eSignature listener events across every package?
      - Can I page through signature event logs by record number, say records 26 to 50?
      instructions:
      - text: Show the first 25 eSignature event log entries across all packages.
      - text: List eSignature event log records {from} through {to}.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/eventlogs/{packageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the event log for one signature package
      effect: read
      questions:
      - What events have been recorded for a single signature package I sent?
      - Can I see the listener event history for just one eSignature package ID?
      instructions:
      - text: Pull the event log for signature package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show me everything the listener recorded for package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/signertypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List signer roles an eSignature provider allows
      effect: read
      questions:
      - What signer types can I put in the Role field when building an envelope?
      - Which recipient roles does a given eSignature service provider accept?
      instructions:
      - text: List the allowed signer types for {signProviderType}.
        slots:
          signProviderType: query.signProviderType
      - text: Show which signer roles I can assign to envelope recipients.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List templates held by the eSignature provider
      effect: read
      questions:
      - What signing templates already exist in my eSignature provider account?
      - Can I see the provider-side templates I could reuse when creating an envelope?
      instructions:
      - text: List the eSignature templates available in {signProviderType}.
        slots:
          signProviderType: query.signProviderType
      - text: Fetch the sign provider's template list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/transaction/{objectId}/latestSignTransaction'].get
  update:
    x-apievangelist-phrasing:
      intent: Find which sign provider handled a record's latest signing
      effect: read
      questions:
      - Which eSignature provider was used for the most recent signing on this agreement?
      - Can I tell whether the last signature request on a record went through the provider I expect?
      instructions:
      - text: Find the sign provider used on the latest eSign transaction for record {objectId}.
        slots:
          objectId: path.objectId
      - text: Tell me which signature service handled the newest signing request on {objectId}.
        slots:
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/transactionByObjectId/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up signature transaction details by record ID
      effect: read
      questions:
      - I only have the agreement record ID I used for the envelope; can I still get its signing status?
      - Is there a way to look up eSignature transaction details from the object ID instead of the package ID?
      instructions:
      - text: Get the eSignature transaction details for record {objectId}.
        slots:
          objectId: path.objectId
      - text: Look up the signing transaction that was created for object {objectId}.
        slots:
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/usersearch/{searchString}'].get
  update:
    x-apievangelist-phrasing:
      intent: Search users and contacts to add as signers
      effect: read
      questions:
      - Can I search users and contacts by part of their name to pick signature recipients?
      - How do I find a colleague to add as a signer when I only remember a few letters of their name?
      instructions:
      - text: Search users and contacts matching {searchString} for signature recipients.
        slots:
          searchString: path.searchString
      - text: Find people whose names contain {searchString} so I can add them as signers.
        slots:
          searchString: path.searchString
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/void/{objectId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Void a pending eSignature request
      effect: destructive
      questions:
      - Can I void a signature request that's already been sent out on an agreement?
      - Is it possible to record a reason and notify the other recipients when I void an envelope?
      instructions:
      - text: Void the eSignature request on record {objectId}.
        slots:
          objectId: path.objectId
      - text: 'Void the envelope for {objectId} with reason {voidReason} and notify the other recipients: {notifyOthers}.'
        slots:
          objectId: path.objectId
          voidReason: query.voidReason
          notifyOthers: query.notifyOthers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/wetsign/{transactionId}/end'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark an eSign wet-sign transaction complete
      effect: write
      questions:
      - In the eSign service, can I mark a wet-sign transaction as ended and upload the paper-signed document?
      - What happens to the eSignature transaction when I finish a wet-sign and supply the signed file?
      instructions:
      - text: Mark eSign wet-sign transaction {transactionId} as ended.
        slots:
          transactionId: path.transactionId
      - text: Upload {file} as the signed document and end the eSign wet-sign flow {transactionId}.
        slots:
          file: requestBody.file
          transactionId: path.transactionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get signing status and dates for a package
      effect: read
      questions:
      - Has my envelope been signed yet, and when was it sent and signed?
      - If a recipient declined to sign, where do I see the reason they gave?
      instructions:
      - text: Get the status, sent date and signed date for transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Check whether package {transactionId} was declined and why.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-10-01'