API Evangelist conversational phrasing for Conga Role API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Role API
  version: 1.0.0
extends: openapi/conga-role-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-packages/{packageId}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an ad hoc signer group to a transaction
      effect: write
      questions:
      - How do I create a group where any one member can sign for everyone?
      - Can I add an ad hoc group of signers to an existing transaction?
      instructions:
      - text: Add an ad hoc signing group to package {packageId}.
        slots:
          packageId: path.packageId
      - text: Create an ad hoc group in transaction {packageId} where one member signs for all.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/groups/{roleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an ad hoc group's members
      effect: write
      questions:
      - How do I change the members of an ad hoc group in a transaction?
      - Can I add someone to an existing ad hoc signing group?
      instructions:
      - text: Update ad hoc group {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Change the members of ad hoc group {roleId} in transaction {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/groups/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ad hoc group
      effect: destructive
      questions:
      - What happens to member roles when I delete an ad hoc group?
      - How do I remove an ad hoc signing group from a transaction?
      instructions:
      - text: Delete ad hoc group {roleId} from package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Remove the ad hoc group {roleId} and its members from transaction {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a package's roles
      effect: read
      questions:
      - Who are the signers and roles on a package?
      - How do I list every role in a transaction?
      instructions:
      - text: List all roles in package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show me the recipients of package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder a package's signing roles
      effect: write
      questions:
      - Can I change the signing order of roles in a package?
      - How do I move a signer earlier in the signing sequence?
      instructions:
      - text: Reorder the roles in package {packageId}.
        slots:
          packageId: path.packageId
      - text: Change the signing order of package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a signer role to a package
      effect: write
      questions:
      - How do I add another signer to an existing package?
      - Can I require attachments from a new recipient when adding them?
      instructions:
      - text: Add a role named {name} to package {packageId}.
        slots:
          name: requestBody.name
          packageId: path.packageId
      - text: Add signers {signers} as a new role on package {packageId}.
        slots:
          signers: requestBody.signers
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one role in a package
      effect: read
      questions:
      - How do I look up a single signer role on a package?
      - What details are stored for one recipient role?
      instructions:
      - text: Get role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Show the details of recipient {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a signer role
      effect: write
      questions:
      - How do I change a signer's details on a package role?
      - Can I allow a recipient to reassign their signing role?
      instructions:
      - text: Update role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Set reassign to {reassign} on role {roleId} of package {packageId}.
        slots:
          reassign: requestBody.reassign
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a role from a package
      effect: destructive
      questions:
      - How do I remove a signer from a package?
      - Can I delete a recipient role I no longer need?
      instructions:
      - text: Delete role {roleId} from package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Remove signer {roleId} from package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/unlock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a locked signer role
      effect: write
      questions:
      - How do I unlock a signer who got locked out?
      - Can a locked role be unlocked so they can sign again?
      instructions:
      - text: Unlock role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Unlock the locked-out signer {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/runtime/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List platform user-management roles
      effect: read
      questions:
      - Which user-management roles are defined in my Conga platform tenant?
      - Can I exclude deleted roles when listing platform roles by criteria?
      - What's the way to page through tenant roles sorted by name?
      instructions:
      - text: List the tenant's user-management roles matching {criteria}.
        slots:
          criteria: query.criteria
      - text: Show platform roles sorted by {sortField} in {sortDirection} order, {pageSize} per page.
        slots:
          sortField: query.sortField
          sortDirection: query.sortDirection
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'