# 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 Views API
  version: 1.0.0
extends: openapi/docusign-envelopeviews-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: 9
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}/views/recipient'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an embedded signing URL for a recipient
      effect: write
      questions:
      - How do I let a recipient sign inside my own app using the unversioned views endpoint?
      - How long is an embedded signing link valid?
      instructions:
      - text: Embed signing of envelope {envelope}, account {account}, for {userName} ({email}), back to {returnUrl}, auth {authenticationMethod}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          userName: requestBody.userName
          email: requestBody.email
          returnUrl: requestBody.returnUrl
          authenticationMethod: requestBody.authenticationMethod
      - text: Generate a signing link for client user {clientUserId} on envelope {envelope} via the unversioned recipient view.
        slots:
          clientUserId: requestBody.clientUserId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}/views/sender'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an embedded sender URL (unversioned)
      effect: write
      questions:
      - Can I let a sender edit a draft envelope inside my app through the unversioned sender view?
      - Where does the embedded sender get redirected after editing the draft?
      instructions:
      - text: Create an unversioned sender view for draft envelope {envelope} in account {account} returning to {returnUrl}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          returnUrl: requestBody.returnUrl
      - text: Let me edit draft envelope {envelope} before sending, via the unversioned sender view.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL to correct an envelope
      effect: write
      questions:
      - How do I embed the envelope correction screen in my app?
      - Can I hide navigation in the correction view?
      instructions:
      - text: Create a correction view URL for envelope {envelope} in account {account} returning to {returnUrl}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          returnUrl: requestBody.returnUrl
      - text: 'Open the correct view for envelope {envelope} with navigation suppressed: {suppressNavigation}.'
        slots:
          envelope: path.envelopeId
          suppressNavigation: requestBody.suppressNavigation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an envelope correction view URL
      effect: destructive
      questions:
      - Can I invalidate a correction view link I generated earlier?
      - How do I revoke an embedded correct view on an envelope?
      instructions:
      - text: Revoke the correction view for envelope {envelope} in account {account}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Invalidate the correct-view link I made for envelope {envelope}.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/views/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL to the envelope edit view
      effect: write
      questions:
      - How do I embed the envelope editing screen with a one-time login token?
      - Can I send a user straight into editing an existing envelope?
      instructions:
      - text: Create an edit view URL for envelope {envelope} in account {account} that returns to {returnUrl}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          returnUrl: requestBody.returnUrl
      - text: Put me in the editing screen for envelope {envelope}.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/views/recipient'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a v2 embedded recipient signing URL
      effect: write
      questions:
      - How do I start the v2 signing ceremony for an embedded signer?
      - Can I restrict which sites may frame the v2 recipient view?
      instructions:
      - text: Create a v2 recipient view for {userName} ({email}) on envelope {envelope} in account {account}.
        slots:
          userName: requestBody.userName
          email: requestBody.email
          envelope: path.envelopeId
          account: path.accountId
      - text: Generate a v2 signing URL for client user {clientUserId} on envelope {envelope} returning to {returnUrl}.
        slots:
          clientUserId: requestBody.clientUserId
          envelope: path.envelopeId
          returnUrl: requestBody.returnUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a v2 embedded sender URL
      effect: write
      questions:
      - Can I embed the v2 sender view so users can tag and send an envelope in my app?
      - Is the v2 sender view URL single use?
      instructions:
      - text: Create a v2 sender view for envelope {envelope} in account {account} that returns to {returnUrl}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          returnUrl: requestBody.returnUrl
      - text: Embed the v2 sending screen for envelope {envelope} in my app.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/views/shared'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a shared recipient view URL
      effect: write
      questions:
      - How can a user view an envelope shared with them through an embedded shared view?
      - Can I open a shared envelope view for a specific user ID?
      instructions:
      - text: Create a shared recipient view of envelope {envelope} in account {account} for user {userId}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          userId: requestBody.userId
      - text: Open shared envelope {envelope} for {email} through the shared view.
        slots:
          envelope: path.envelopeId
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/views/console'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL to the account console
      effect: write
      questions:
      - How do I embed the full web console for an account in my app?
      - Can I open the console directly on a specific envelope?
      instructions:
      - text: Create a console view URL for account {account}.
        slots:
          account: path.accountId
      - text: Open the console for account {account} on envelope {envelopeId} returning to {returnUrl}.
        slots:
          account: path.accountId
          envelopeId: requestBody.envelopeId
          returnUrl: requestBody.returnUrl
      method: generated
      generated: '2026-10-01'