# 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 Package API
  version: 1.0.0
extends: openapi/conga-package-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: 15
- target: $.paths['/v1/cs-packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List document packages
      effect: read
      questions:
      - How do I list the signing packages in my Conga Sign account?
      - Can I see packages owned by another user in my account?
      instructions:
      - text: List my document packages.
      - text: Show all signing packages I own.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a package or template
      effect: write
      questions:
      - How do I create a new signing transaction without attachments?
      - Can I create a reusable template instead of a package?
      - What fields can I set when creating a package, like due date or language?
      instructions:
      - text: Create a package named {name}.
        slots:
          name: requestBody.name
      - text: Create a template called {name} by setting type to {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Create package {name} due on {due}.
        slots:
          name: requestBody.name
          due: requestBody.due
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's details
      effect: read
      questions:
      - How do I look up a package's status, roles and documents?
      - Can I retrieve a package with the raw signature capture included?
      instructions:
      - text: Get the details of package {packageId}.
        slots:
          packageId: path.packageId
      - text: Fetch package {packageId} with raw signature capture {rawSignatureCapture}.
        slots:
          packageId: path.packageId
          rawSignatureCapture: query.rawSignatureCapture
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a package
      effect: write
      questions:
      - How do I change the name or due date of an existing package?
      - Can I update a package's email message after creating it?
      instructions:
      - text: Rename package {packageId} to {name}.
        slots:
          packageId: path.packageId
          name: requestBody.name
      - text: Change the due date of package {packageId} to {due}.
        slots:
          packageId: path.packageId
          due: requestBody.due
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a package or template
      effect: destructive
      questions:
      - How do I permanently delete a package?
      - Can I delete a template the same way as a package?
      instructions:
      - text: Delete package {packageId}.
        slots:
          packageId: path.packageId
      - text: Remove template {packageId} from my account.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's audit trail
      effect: read
      questions:
      - Where can I see the audit trail of who did what on a package?
      - How do I pull the audit events for a signing transaction?
      instructions:
      - text: Get the audit trail for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show audit details of package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/bulk_send'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk send packages from a template
      effect: write
      questions:
      - How do I send the same template to many signers using bulk send?
      - What do I need enabled before bulk sending from a template?
      instructions:
      - text: Bulk send template {packageId} using recipient file {File}.
        slots:
          packageId: path.packageId
          File: requestBody.File
      - text: Create and send packages in bulk from template {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a package or template
      effect: write
      questions:
      - Can I make a new package by copying an existing one?
      - How do I turn an existing package into a template?
      instructions:
      - text: Clone package {packageId}.
        slots:
          packageId: path.packageId
      - text: Copy package {packageId} into a new template named {name}.
        slots:
          packageId: path.packageId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/evidence/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's evidence summary
      effect: read
      questions:
      - How do I download the evidence summary for a completed package?
      - Is there a summary of signing evidence for a transaction?
      instructions:
      - text: Get the evidence summary for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Summarize signing evidence for package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/fieldSummary'].get
  update:
    x-apievangelist-phrasing:
      intent: List form fields by document and signer
      effect: read
      questions:
      - What form fields are in a package, grouped by signer?
      - How do I see the field values entered across a package's documents?
      instructions:
      - text: List the form fields in package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show the field summary for package {packageId} grouped by document and signer.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/readiness'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a package is ready to send
      effect: read
      questions:
      - Is my package ready to be sent for signature?
      - How can I check a package's send readiness before sending it?
      instructions:
      - text: Check whether package {packageId} is ready to send.
        slots:
          packageId: path.packageId
      - text: Get the send readiness of package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/referencedConditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List conditions referencing a field or document
      effect: read
      questions:
      - Which conditional logic rules in a package reference a given field?
      - Can I find conditions that depend on a particular document?
      instructions:
      - text: List conditions in package {packageId} that reference field {fieldId}.
        slots:
          packageId: path.packageId
          fieldId: query.fieldId
      - text: Show referenced conditions for document {documentId} in package {packageId}.
        slots:
          documentId: query.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/signingUrl'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signer's signing URL
      effect: read
      questions:
      - How do I get the link a signer uses to sign a sent package?
      - Why can't I get a signing URL for a draft package?
      instructions:
      - text: Get the signing URL for role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Give me signer {roleId}'s signing link for package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/signers/{signerId}/approvals'].get
  update:
    x-apievangelist-phrasing:
      intent: List a signer's approvals in a package
      effect: read
      questions:
      - Which signatures has a specific signer been assigned in a package?
      - How do I list all approvals for one signer?
      instructions:
      - text: List approvals for signer {signerId} in package {packageId}.
        slots:
          signerId: path.signerId
          packageId: path.packageId
      - text: Show every signature block assigned to signer {signerId} in package {packageId}.
        slots:
          signerId: path.signerId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/signingStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's signing status
      effect: read
      questions:
      - Has everyone signed my package yet?
      - Can I see signing progress broken down by signer or document?
      instructions:
      - text: Get the signing status of package {packageId}.
        slots:
          packageId: path.packageId
      - text: Tell me who still needs to sign package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'