DocuSign REST API — EnvelopeDocumentVisibility

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — EnvelopeDocumentVisibility
  description: 'DocuSign REST API — EnvelopeDocumentVisibility. 3 operations. Lead operation: Docusign Updates document visibility
    for the recipients. Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - EnvelopeDocumentVisibility
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-envelopedocumentvisibility
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — EnvelopeDocumentVisibility business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-envelopes-envelopeId-recipients-document_visibility
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility
      operations:
      - name: recipientsputrecipientsdocumentvisibility
        method: PUT
        description: Docusign Updates document visibility for the recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-accounts-accountId-envelopes-envelopeId-recipients-recipientId-document_visib
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
      operations:
      - name: recipientsgetrecipientdocumentvisibility
        method: GET
        description: Docusign Returns document visibility for the recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: recipientId
          in: path
          type: string
          description: A local reference that senders use to map recipients to other objects, such as specific document tabs.
            Within an envelope, each `recipientId` must be unique, bu
          required: true
      - name: recipientsputrecipientdocumentvisibility
        method: PUT
        description: Docusign Updates document visibility for the recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: recipientId
          in: path
          type: string
          description: A local reference that senders use to map recipients to other objects, such as specific document tabs.
            Within an envelope, each `recipientId` must be unique, bu
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: docusign-envelopedocumentvisibility-rest
    port: 8080
    description: REST adapter for DocuSign REST API — EnvelopeDocumentVisibility. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/recipients/document-visibility
      name: v2-accounts-accountid-envelopes-envelopeid-recipients-document-visibility
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-recipients-document_visibility.
      operations:
      - method: PUT
        name: recipientsputrecipientsdocumentvisibility
        description: Docusign Updates document visibility for the recipients
        call: docusign-envelopedocumentvisibility.recipientsputrecipientsdocumentvisibility
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/recipients/{recipientid}/document-visibility
      name: v2-accounts-accountid-envelopes-envelopeid-recipients-recipientid-document-visib
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-recipients-recipientId-document_visib.
      operations:
      - method: GET
        name: recipientsgetrecipientdocumentvisibility
        description: Docusign Returns document visibility for the recipients
        call: docusign-envelopedocumentvisibility.recipientsgetrecipientdocumentvisibility
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          recipientId: rest.recipientId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: recipientsputrecipientdocumentvisibility
        description: Docusign Updates document visibility for the recipients
        call: docusign-envelopedocumentvisibility.recipientsputrecipientdocumentvisibility
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          recipientId: rest.recipientId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-envelopedocumentvisibility-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — EnvelopeDocumentVisibility. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: docusign-updates-document-visibility-recipients
      description: Docusign Updates document visibility for the recipients
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-envelopedocumentvisibility.recipientsputrecipientsdocumentvisibility
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-returns-document-visibility-recipients
      description: Docusign Returns document visibility for the recipients
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-envelopedocumentvisibility.recipientsgetrecipientdocumentvisibility
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        recipientId: tools.recipientId
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-updates-document-visibility-recipients-2
      description: Docusign Updates document visibility for the recipients
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-envelopedocumentvisibility.recipientsputrecipientdocumentvisibility
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        recipientId: tools.recipientId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.