# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docusign Envelope Documents API
  version: 1.0.0
extends: openapi/docusign-envelopedocuments-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['/accounts/{accountId}/envelopes/{envelopeId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List envelope documents (unversioned endpoint)
      effect: read
      questions:
      - Which documents are inside an envelope, with their names, types and order?
      - Can I get document metadata for an envelope without the v2 path?
      instructions:
      - text: List the documents in envelope {envelope} for account {account} using the unversioned endpoint.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Show names, types and order of the documents in envelope {envelope} via the non-v2 path.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an envelope document (unversioned endpoint)
      effect: read
      questions:
      - Can I fetch a single document's content from an envelope through the simpler non-v2 endpoint?
      - What format does a document come back in from the unversioned download path?
      instructions:
      - text: Download document {document} from envelope {envelope} in account {account} using the unversioned endpoint.
        slots:
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Get the file for document {document} of envelope {envelope} via the non-v2 path.
        slots:
          document: path.documentId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List an envelope's documents with optional sizes
      effect: read
      questions:
      - How do I see every document attached to an envelope along with file sizes?
      - Can the v2 document list include how big each document is?
      instructions:
      - text: List documents in envelope {envelope} for account {account} with document sizes.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Show the v2 document list for envelope {envelope}.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents'].put
  update:
    x-apievangelist-phrasing:
      intent: Add documents to an existing envelope
      effect: write
      questions:
      - Can I add more documents to an envelope that's already been created?
      - Should an in-process envelope be locked before I add documents to it?
      - Can tabs be kept when I add several documents at once?
      instructions:
      - text: Add documents {documents} to envelope {envelope} in account {account}.
        slots:
          documents: requestBody.documents
          envelope: path.envelopeId
          account: path.accountId
      - text: Attach documents {documents} to envelope {envelope} and keep existing tabs.
        slots:
          documents: requestBody.documents
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove documents from a draft envelope
      effect: destructive
      questions:
      - How do I remove a document from an envelope that hasn't been completed?
      - Can I delete documents from an envelope once it's finished?
      instructions:
      - text: Delete documents {documents} from envelope {envelope} in account {account}.
        slots:
          documents: requestBody.documents
          envelope: path.envelopeId
          account: path.accountId
      - text: Remove document entries {documents} from draft envelope {envelope}.
        slots:
          documents: requestBody.documents
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a document, combined PDF or certificate
      effect: read
      questions:
      - How do I download all of an envelope's documents combined into one PDF?
      - Can the downloaded document highlight changes or include the certificate of completion?
      - Is a watermark or a specific language possible on the downloaded document?
      instructions:
      - text: Download document {document} from envelope {envelope} in account {account}.
        slots:
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Download document {document} of envelope {envelope} with changes highlighted.
        slots:
          document: path.documentId
          envelope: path.envelopeId
      - text: Get document {document} from envelope {envelope} in language {language}.
        slots:
          document: path.documentId
          envelope: path.envelopeId
          language: query.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or replace one document in a draft envelope
      effect: write
      questions:
      - Can I upload a single document into a specific slot of a draft envelope?
      - Will document fields be applied when I put one document into a draft?
      instructions:
      - text: Add document {document} to draft envelope {envelope} in account {account}.
        slots:
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Upload a file as document {document} on envelope {envelope} and apply its document fields.
        slots:
          document: path.documentId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'