DocuSign REST API — EnvelopeLocks

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — EnvelopeLocks
  description: 'DocuSign REST API — EnvelopeLocks. 4 operations. Lead operation: Docusign Gets envelope lock information..
    Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - EnvelopeLocks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-envelopelocks
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — EnvelopeLocks business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-envelopes-envelopeId-lock
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/lock
      operations:
      - name: lockgetenvelopelock
        method: GET
        description: Docusign Gets envelope lock information.
        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: lockputenvelopelock
        method: PUT
        description: Docusign Updates an envelope lock.
        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: lockpostenvelopelock
        method: POST
        description: Docusign Lock an envelope.
        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: lockdeleteenvelopelock
        method: DELETE
        description: Docusign Deletes an envelope lock.
        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
  exposes:
  - type: rest
    namespace: docusign-envelopelocks-rest
    port: 8080
    description: REST adapter for DocuSign REST API — EnvelopeLocks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/lock
      name: v2-accounts-accountid-envelopes-envelopeid-lock
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-lock.
      operations:
      - method: GET
        name: lockgetenvelopelock
        description: Docusign Gets envelope lock information.
        call: docusign-envelopelocks.lockgetenvelopelock
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: lockputenvelopelock
        description: Docusign Updates an envelope lock.
        call: docusign-envelopelocks.lockputenvelopelock
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: lockpostenvelopelock
        description: Docusign Lock an envelope.
        call: docusign-envelopelocks.lockpostenvelopelock
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: lockdeleteenvelopelock
        description: Docusign Deletes an envelope lock.
        call: docusign-envelopelocks.lockdeleteenvelopelock
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-envelopelocks-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — EnvelopeLocks. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: docusign-gets-envelope-lock-information
      description: Docusign Gets envelope lock information.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-envelopelocks.lockgetenvelopelock
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-updates-envelope-lock
      description: Docusign Updates an envelope lock.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-envelopelocks.lockputenvelopelock
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-lock-envelope
      description: Docusign Lock an envelope.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: docusign-envelopelocks.lockpostenvelopelock
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-deletes-envelope-lock
      description: Docusign Deletes an envelope lock.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: docusign-envelopelocks.lockdeleteenvelopelock
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
      outputParameters:
      - type: object
        mapping: $.