API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…
  version: 1.0.0
extends: openapi/onetrust-consent-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/api/consent/v2/consent-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List consent groups
      effect: read
      questions:
      - What consent groups have been set up in OneTrust?
      - Can I find a consent group by its name?
      - Which purpose rules and members does each consent group have?
      instructions:
      - text: List all consent groups.
      - text: Find the consent group named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a consent group
      effect: write
      questions:
      - How do I create a new consent group for households or accounts?
      - What happens if I don't give a consent group an external name?
      instructions:
      - text: Create a consent group called {name}.
        slots:
          name: requestBody.name
      - text: Create consent group {name} with external name {externalName} and description {description}.
        slots:
          name: requestBody.name
          externalName: requestBody.externalName
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get purpose status priority scores
      effect: read
      questions:
      - What priority score does each purpose status have for consent groups?
      - Which purpose status wins when group members disagree on consent?
      instructions:
      - text: Show the current priority scores for purpose statuses.
      - text: Get the consent group settings that rank purpose statuses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update purpose status priority scores
      effect: write
      questions:
      - How do I change which purpose status takes precedence in a consent group hierarchy?
      - Can I reorder priority scores used to calculate a purpose's effective status?
      instructions:
      - text: Set the purpose status priority rules to {statusPriorityRules}.
        slots:
          statusPriorityRules: requestBody.statusPriorityRules
      - text: Update consent group priority scores with {statusPriorityRules}.
        slots:
          statusPriorityRules: requestBody.statusPriorityRules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consent group
      effect: read
      questions:
      - How do I view one consent group's purpose rules and members?
      - What data subjects or child groups belong to a specific consent group?
      instructions:
      - text: Show consent group {consentGroupGuid}.
        slots:
          consentGroupGuid: path.consentGroupGuid
      - text: Get the hierarchy and purpose rules of consent group {consentGroupGuid}.
        slots:
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/consent-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Nest consent groups under a parent group
      effect: write
      questions:
      - How do I make consent groups children of a parent consent group?
      - Can a consent group belong to more than one parent group?
      instructions:
      - text: Add consent groups {consentGroupIds} as children of group {consentGroupGuid}.
        slots:
          consentGroupIds: requestBody.consentGroupIds
          consentGroupGuid: path.consentGroupGuid
      - text: Nest child groups {consentGroupIds} under parent consent group {consentGroupGuid}.
        slots:
          consentGroupIds: requestBody.consentGroupIds
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/consent-groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove child consent groups from a parent
      effect: destructive
      questions:
      - How do I detach child consent groups from their parent group?
      - Can I unlink several child consent groups in one call?
      instructions:
      - text: Remove child groups {consentGroupIds} from parent consent group {consentGroupGuid}.
        slots:
          consentGroupIds: requestBody.consentGroupIds
          consentGroupGuid: path.consentGroupGuid
      - text: Unlink child consent groups {consentGroupIds} from {consentGroupGuid}.
        slots:
          consentGroupIds: requestBody.consentGroupIds
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/data-subjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Add data subjects to a consent group
      effect: write
      questions:
      - How do I put individual data subjects into a consent group?
      - Can a parent consent group hold both data subjects and child groups at the same level?
      instructions:
      - text: Add data subjects {dataSubjects} to consent group {consentGroupGuid}.
        slots:
          dataSubjects: requestBody.dataSubjects
          consentGroupGuid: path.consentGroupGuid
      - text: Enroll people {dataSubjects} as members of consent group {consentGroupGuid}.
        slots:
          dataSubjects: requestBody.dataSubjects
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/data-subjects/{dataSubjectGuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a data subject from a consent group
      effect: destructive
      questions:
      - How do I take one person out of a consent group?
      - Can I remove more than one data subject from a consent group per call?
      instructions:
      - text: Remove data subject {dataSubjectGuid} from consent group {consentGroupGuid}.
        slots:
          dataSubjectGuid: path.dataSubjectGuid
          consentGroupGuid: path.consentGroupGuid
      - text: Take member {dataSubjectGuid} out of consent group {consentGroupGuid}.
        slots:
          dataSubjectGuid: path.dataSubjectGuid
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/purpose-rules'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a consent group's purpose rules
      effect: write
      questions:
      - How do I change the enforced status on purpose rules a consent group already has?
      - Can I edit existing purpose rules on a consent group?
      instructions:
      - text: Update the existing purpose rules on consent group {consentGroupGuid} to {purposeRules}.
        slots:
          consentGroupGuid: path.consentGroupGuid
          purposeRules: requestBody.purposeRules
      - text: Change the enforced statuses of purpose rules in group {consentGroupGuid}.
        slots:
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/purpose-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add purpose rules to a consent group
      effect: write
      questions:
      - How do I force a purpose to a set status for everyone in a consent group?
      - Can I attach new purpose rules that override members' consent?
      instructions:
      - text: Add purpose rules {purposeRules} to consent group {consentGroupGuid}.
        slots:
          purposeRules: requestBody.purposeRules
          consentGroupGuid: path.consentGroupGuid
      - text: Attach a new enforced-status purpose rule to group {consentGroupGuid}.
        slots:
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consent/v2/consent-groups/{consentGroupGuid}/purpose-rules/{purposeGuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a purpose rule from a consent group
      effect: destructive
      questions:
      - How do I stop a consent group from overriding a particular purpose?
      - Can I delete a single purpose rule from a consent group?
      instructions:
      - text: Remove the purpose rule for {purposeGuid} from consent group {consentGroupGuid}.
        slots:
          purposeGuid: path.purposeGuid
          consentGroupGuid: path.consentGroupGuid
      - text: Delete purpose {purposeGuid}'s rule on group {consentGroupGuid}.
        slots:
          purposeGuid: path.purposeGuid
          consentGroupGuid: path.consentGroupGuid
      method: generated
      generated: '2026-09-26'