# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Sign Sender API
  version: 1.0.0
extends: openapi/conga-sender-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: 11
- target: $.paths['/v1/cs-account/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the signing account
      effect: read
      questions:
      - Who are the senders set up in my Conga Sign account?
      - Can I search account users by name and page through the results?
      - Why does listing senders only return one user by default?
      instructions:
      - text: List the senders in my account from record {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Search account users for "{search}".
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new user to the signing account
      effect: write
      questions:
      - How do I add a new sender to my e-signature account?
      - Can I create a notary user in the account?
      instructions:
      - text: Create a sender for {firstName} {lastName} with email {email}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
      - text: Add user {email} to the account with language {language}.
        slots:
          email: requestBody.email
          language: requestBody.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sender's account details
      effect: read
      questions:
      - What details are stored for a specific sender in the account?
      - Is a given user locked or activated?
      instructions:
      - text: Get the account details for sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Show me sender {senderId}'s profile and status.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a sender's details
      effect: write
      questions:
      - Can I change an existing sender's name, title or phone number?
      - Which fields on a sender's profile can be edited?
      instructions:
      - text: Change sender {senderId}'s title to {title}.
        slots:
          senderId: path.senderId
          title: requestBody.title
      - text: Update sender {senderId}'s phone to {phone} and company to {company}.
        slots:
          senderId: path.senderId
          phone: requestBody.phone
          company: requestBody.company
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a sender from the account
      effect: destructive
      questions:
      - Can I delete a user who has left the company from my signing account?
      - What's the way to permanently remove a sender?
      instructions:
      - text: Delete sender {senderId} from the account.
        slots:
          senderId: path.senderId
      - text: Remove user {senderId} permanently.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Email an account invitation to a user
      effect: write
      questions:
      - How do I send an invitation email so a user can join the account?
      - Can I resend the account invite link to a sender?
      instructions:
      - text: Invite sender {senderId} to join the account.
        slots:
          senderId: path.senderId
      - text: Email the account invitation link to user {senderId}.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/password'].post
  update:
    x-apievangelist-phrasing:
      intent: Change my own sender password
      effect: write
      questions:
      - Can I change my own password through the API if I know the current one?
      - Is it possible to change another user's password?
      instructions:
      - text: Change the password for sender {senderId} from my current password to {newPassword}.
        slots:
          senderId: path.senderId
          newPassword: requestBody.newPassword
      - text: Update my password as {email}, sender {senderId}.
        slots:
          email: requestBody.email
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/resetpassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a password reset email to a user
      effect: write
      questions:
      - A user forgot their password; can I trigger a reset email for them?
      - What does resetting a sender's password actually send?
      instructions:
      - text: Send a password reset email to sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Reset the password for user {senderId} so they can choose a new one.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/signature/image'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sender's default signature image
      effect: read
      questions:
      - What signature image does a sender use by default when signing?
      - Can I download a user's saved signature?
      instructions:
      - text: Download the default signature image for sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Show me the saved signature of user {senderId}.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/signature/image'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a sender's default signature image
      effect: write
      questions:
      - How do I upload a scanned signature for a user to sign with?
      - Can a sender's default signature be set from an image file?
      instructions:
      - text: Upload {fileName} as the default signature for sender {senderId}.
        slots:
          fileName: requestBody.FileName
          senderId: path.senderId
      - text: Set a new signature image for user {senderId}.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/signature/image'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender's default signature image
      effect: destructive
      questions:
      - Can I clear the stored signature image for a user?
      - What happens if I remove a sender's default signature?
      instructions:
      - text: Delete the signature image for sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Remove user {senderId}'s saved default signature.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-10-01'