# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Envelope Locks API
  version: 1.0.0
extends: openapi/docusign-envelopelocks-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: 4
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/lock'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an envelope is locked
      effect: read
      questions:
      - Who has an envelope locked and when does the lock expire?
      - Can I recover a lost editing session from an envelope lock?
      instructions:
      - text: Show the lock on envelope {envelopeId}.
        slots:
          envelopeId: path.envelopeId
      - text: Get lock information for envelope {envelopeId} in account {accountId}.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/lock'].put
  update:
    x-apievangelist-phrasing:
      intent: Extend or change an envelope lock
      effect: write
      questions:
      - Can I extend how long my lock on an envelope lasts?
      - Which header is required to update an existing envelope lock?
      instructions:
      - text: Extend the lock on envelope {envelopeId} to {lockDurationInSeconds} seconds.
        slots:
          envelopeId: path.envelopeId
          lockDurationInSeconds: requestBody.lockDurationInSeconds
      - text: Update the lock on envelope {envelopeId} in account {accountId} to app {lockedByApp}.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
          lockedByApp: requestBody.lockedByApp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/lock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock an envelope for editing
      effect: write
      questions:
      - Can I lock an envelope so nobody else changes it while I edit?
      - What user setting must be on before I can lock envelopes?
      instructions:
      - text: Lock envelope {envelopeId} for {lockDurationInSeconds} seconds.
        slots:
          envelopeId: path.envelopeId
          lockDurationInSeconds: requestBody.lockDurationInSeconds
      - text: Place an edit lock on envelope {envelopeId} in account {accountId}.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/lock'].delete
  update:
    x-apievangelist-phrasing:
      intent: Release an envelope lock
      effect: destructive
      questions:
      - Can I unlock an envelope once I'm done editing?
      - What do I have to send to remove a lock from an envelope?
      instructions:
      - text: Unlock envelope {envelopeId}.
        slots:
          envelopeId: path.envelopeId
      - text: Remove the lock from envelope {envelopeId} in account {accountId}.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'