API Evangelist conversational phrasing for DocuSign Click Click Wraps API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign Click Click Wraps API
  version: 1.0.0
extends: openapi/docusign-clickwraps-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: 21
- target: $.paths['/service_information'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Click API version and build
      effect: read
      questions:
      - Which version of the DocuSign Click API is currently running?
      - Can I see the build number and linked sites for the Click service?
      instructions:
      - text: Show me the Click API service version and build information.
      - text: Get the linked sites and version URLs for the clickwrap service.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the clickwraps in an account
      effect: read
      questions:
      - What clickwraps exist in my account right now?
      - Can I filter my clickwraps by status, owner or a date range?
      - Is there a way to see only the shared clickwraps?
      instructions:
      - text: List all clickwraps in account {account}.
        slots:
          account: path.accountId
      - text: List clickwraps in account {account} with status {status}.
        slots:
          account: path.accountId
          status: query.status
      - text: Show clickwraps owned by user {owner} in account {account}.
        slots:
          owner: query.ownerUserId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new clickwrap agreement
      effect: write
      questions:
      - How do I create a clickwrap terms-of-service agreement for my website?
      - Can a new clickwrap be scheduled to go live on a future date?
      instructions:
      - text: Create a clickwrap named {name} in account {account}.
        slots:
          name: requestBody.clickwrapName
          account: path.accountId
      - text: Create a shared clickwrap called {name} in account {account} with the attached documents {documents}.
        slots:
          name: requestBody.clickwrapName
          account: path.accountId
          documents: requestBody.documents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete clickwraps in an account
      effect: destructive
      questions:
      - Can I delete several clickwraps at once by listing their IDs?
      - What happens if I bulk delete without naming specific clickwraps?
      instructions:
      - text: Delete the clickwraps {clickwrap_ids} from account {account}.
        slots:
          clickwrap_ids: query.clickwrapIds
          account: path.accountId
      - text: Remove every clickwrap in account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single clickwrap's details
      effect: read
      questions:
      - How can I look up the settings of one particular clickwrap?
      - Where do I see a single clickwrap's current status and display settings?
      instructions:
      - text: Get clickwrap {clickwrap} in account {account}.
        slots:
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show me the details of clickwrap {clickwrap}.
        slots:
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Transfer a clickwrap to a different owner
      effect: write
      questions:
      - Can I hand ownership of a clickwrap from one user to another?
      - What do I need to reassign a clickwrap when its owner leaves the company?
      instructions:
      - text: Transfer clickwrap {clickwrap} in account {account} from user {from_user} to user {to_user}.
        slots:
          clickwrap: path.clickwrapId
          account: path.accountId
          from_user: requestBody.transferFromUserId
          to_user: requestBody.transferToUserId
      - text: Make user {to_user} the owner of clickwrap {clickwrap}.
        slots:
          to_user: requestBody.transferToUserId
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one clickwrap and all its versions
      effect: destructive
      questions:
      - Can I delete a clickwrap that is still active?
      - Does deleting a single clickwrap also remove every version of it?
      instructions:
      - text: Delete clickwrap {clickwrap} and all of its versions from account {account}.
        slots:
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Delete only versions {versions} of clickwrap {clickwrap}.
        slots:
          versions: query.versions
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a user agreed to a clickwrap
      effect: read
      questions:
      - How do I find out if a site visitor has already accepted my clickwrap?
      - Will I get an agreement URL back when a user still needs to accept the terms?
      instructions:
      - text: Check whether client user {client_user} has agreed to clickwrap {clickwrap} in account {account}.
        slots:
          client_user: requestBody.clientUserId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Get the pending agreement link for {client_user} on clickwrap {clickwrap}.
        slots:
          client_user: requestBody.clientUserId
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's clickwrap agreement record
      effect: read
      questions:
      - Can I pull up the record of a specific acceptance of a clickwrap?
      - Which details are stored for an individual clickwrap agreement?
      instructions:
      - text: Get agreement {agreement} for clickwrap {clickwrap} in account {account}.
        slots:
          agreement: path.agreementId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show the acceptance record {agreement} on clickwrap {clickwrap}.
        slots:
          agreement: path.agreementId
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the PDF of a completed clickwrap agreement
      effect: read
      questions:
      - Can I download a signed copy of a user's clickwrap acceptance as a PDF?
      - Where do I get proof of acceptance as a file for my records?
      instructions:
      - text: Download the PDF of agreement {agreement} for clickwrap {clickwrap} in account {account}.
        slots:
          agreement: path.agreementId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Save the completed agreement {agreement} on clickwrap {clickwrap} as a PDF.
        slots:
          agreement: path.agreementId
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users' responses to a clickwrap
      effect: read
      questions:
      - Who has accepted or declined my clickwrap across all its versions?
      - Can I filter clickwrap responses by date range or agreement status?
      instructions:
      - text: List user agreements for clickwrap {clickwrap} in account {account}.
        slots:
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show agreements on clickwrap {clickwrap} with status {status} since {from_date}.
        slots:
          clickwrap: path.clickwrapId
          status: query.status
          from_date: query.from_date
      - text: Find the agreements client user {client_user} made on clickwrap {clickwrap}.
        slots:
          client_user: query.client_user_id
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new version of a clickwrap
      effect: write
      questions:
      - How do I roll out updated terms as a new clickwrap version?
      - Can a new clickwrap version force existing users to accept again?
      instructions:
      - text: Create a new version of clickwrap {clickwrap} in account {account}.
        slots:
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Add a major version to clickwrap {clickwrap} that requires re-acceptance, using documents {documents}.
        slots:
          clickwrap: path.clickwrapId
          documents: requestBody.documents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete versions of a clickwrap
      effect: destructive
      questions:
      - Is it possible to delete several old versions of one clickwrap in a single call?
      - What gets removed if I bulk delete versions without listing version IDs?
      instructions:
      - text: Delete versions {version_ids} of clickwrap {clickwrap} in account {account}.
        slots:
          version_ids: query.clickwrapVersionIds
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Remove every version of clickwrap {clickwrap}.
        slots:
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clickwrap version by its version ID
      effect: read
      questions:
      - Can I look up a clickwrap version using its version ID?
      - What settings did a particular clickwrap version ID have?
      instructions:
      - text: Get version ID {version} of clickwrap {clickwrap} in account {account}.
        slots:
          version: path.versionId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show the clickwrap version whose ID is {version}.
        slots:
          version: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a clickwrap version by version ID
      effect: write
      questions:
      - Can I edit an existing clickwrap version referenced by its version ID?
      - Which settings can I change on a clickwrap version identified by ID?
      instructions:
      - text: Update version ID {version} of clickwrap {clickwrap} in account {account}.
        slots:
          version: path.versionId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Rename the clickwrap version with ID {version} to {name}.
        slots:
          version: path.versionId
          name: requestBody.clickwrapName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a clickwrap version by version ID
      effect: destructive
      questions:
      - How can I remove one clickwrap version when I only know its version ID?
      - Does deleting one version by ID leave the clickwrap's other versions intact?
      instructions:
      - text: Delete version ID {version} of clickwrap {clickwrap} in account {account}.
        slots:
          version: path.versionId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Remove the clickwrap version identified by {version}.
        slots:
          version: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List responses to a clickwrap version by ID
      effect: read
      questions:
      - Who accepted the clickwrap version with a given version ID?
      - Can I filter responses to one version ID by date or status?
      instructions:
      - text: List agreement responses for version ID {version} of clickwrap {clickwrap} in account {account}.
        slots:
          version: path.versionId
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show responses with status {status} to version ID {version}.
        slots:
          status: query.status
          version: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clickwrap version by its version number
      effect: read
      questions:
      - Can I fetch version 3 of a clickwrap by number instead of ID?
      - How do I see what the second published version of my clickwrap looked like?
      instructions:
      - text: Get version number {number} of clickwrap {clickwrap} in account {account}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show clickwrap {clickwrap} as it was in version number {number}.
        slots:
          clickwrap: path.clickwrapId
          number: path.versionNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a clickwrap version by version number
      effect: write
      questions:
      - Can I edit a clickwrap version by referring to its sequential number?
      - Is it possible to schedule a numbered clickwrap version for a later date?
      instructions:
      - text: Update version number {number} of clickwrap {clickwrap} in account {account}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Schedule version number {number} of clickwrap {clickwrap} for {date}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
          date: requestBody.scheduledDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a clickwrap version by version number
      effect: destructive
      questions:
      - Can I delete a clickwrap version using its number rather than its ID?
      - How would I drop version 2 from a clickwrap?
      instructions:
      - text: Delete version number {number} of clickwrap {clickwrap} in account {account}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Remove numbered version {number} from clickwrap {clickwrap}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List responses to a clickwrap version by number
      effect: read
      questions:
      - Who agreed to version number 2 of my clickwrap?
      - Can I see declines for a numbered clickwrap version within a date window?
      instructions:
      - text: List agreement responses for version number {number} of clickwrap {clickwrap} in account {account}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
          account: path.accountId
      - text: Show responses to numbered version {number} of clickwrap {clickwrap} before {to_date}.
        slots:
          number: path.versionNumber
          clickwrap: path.clickwrapId
          to_date: query.to_date
      method: generated
      generated: '2026-10-01'