# 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 Account Roles API
  version: 1.0.0
extends: openapi/conga-account-roles-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: 8
- target: $.paths['/v1/cs-account/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List account roles and permissions
      effect: read
      questions:
      - What account roles exist in my Conga Sign account and what permissions do they have?
      - How do I list the roles defined for my account?
      instructions:
      - text: List all account roles.
      - text: Show the account roles and their permissions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account role
      effect: write
      questions:
      - How do I create a custom role with specific permissions for my users?
      - Can I add a disabled account role and enable it later?
      instructions:
      - text: Create an account role named {name}.
        slots:
          name: requestBody.name
      - text: Create account role {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/roles/{accountRoleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account role
      effect: read
      questions:
      - How do I see the permissions on one account role?
      - Can I look up an account role by its ID?
      instructions:
      - text: Get account role {accountRoleId}.
        slots:
          accountRoleId: path.accountRoleId
      - text: Show permissions for account role {accountRoleId}.
        slots:
          accountRoleId: path.accountRoleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/roles/{accountRoleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account role
      effect: write
      questions:
      - How do I change the permissions of an existing account role?
      - Can I rename an account role?
      instructions:
      - text: Rename account role {accountRoleId} to {name}.
        slots:
          accountRoleId: path.accountRoleId
          name: requestBody.name
      - text: Update permissions on account role {accountRoleId} to {permissions}, keeping name {name}.
        slots:
          accountRoleId: path.accountRoleId
          permissions: requestBody.permissions
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/roles/{accountRoleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account role
      effect: destructive
      questions:
      - How do I delete an account role I no longer use?
      - Can I remove a custom role from my account?
      instructions:
      - text: Delete account role {accountRoleId}.
        slots:
          accountRoleId: path.accountRoleId
      - text: Remove the account role {accountRoleId} from my account.
        slots:
          accountRoleId: path.accountRoleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/roles/{accountRoleId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users assigned to an account role
      effect: read
      questions:
      - Which users have a particular account role?
      - How do I find everyone assigned to a role?
      instructions:
      - text: List the user IDs assigned to account role {accountRoleId}.
        slots:
          accountRoleId: path.accountRoleId
      - text: Show who holds account role {accountRoleId}.
        slots:
          accountRoleId: path.accountRoleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's account roles
      effect: read
      questions:
      - What account roles does a specific sender have?
      - Can I see a user's roles within a particular sub-account?
      instructions:
      - text: Get the account roles of sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Show sender {senderId}'s roles in sub-account {accountId}.
        slots:
          senderId: path.senderId
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/senders/{senderId}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign account roles to a user
      effect: write
      questions:
      - How do I give a user an account role?
      - Can I assign roles to a sender within a specific sub-account?
      instructions:
      - text: Assign account roles {accountRoles} to sender {senderId} in account {accountId}.
        slots:
          accountRoles: requestBody.accountRoles
          senderId: path.senderId
          accountId: requestBody.accountId
      - text: Give sender {senderId} the roles {accountRoles} on account {accountId}.
        slots:
          senderId: path.senderId
          accountRoles: requestBody.accountRoles
          accountId: requestBody.accountId
      method: generated
      generated: '2026-10-01'