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-preference-centers-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: 4
- target: $.paths['/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject's preferences in a center
      effect: read
      questions:
      - What has a customer chosen in a particular preference center?
      - Can I see purpose statuses for one person in one preference center?
      instructions:
      - text: Get preferences of {identifier} in preference center {prefcenterId}.
        slots:
          identifier: query.identifier
          prefcenterId: path.prefcenterId
      - text: Show which purposes {identifier} opted into in preference center {prefcenterId}.
        slots:
          identifier: header.identifier
          prefcenterId: path.prefcenterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data subject's preferences in a center
      effect: write
      questions:
      - Can I change a customer's purpose choices in a preference center?
      - Does updating preferences require Pascal case field names?
      instructions:
      - text: Update purposes {Purposes} for {identifier} in preference center {prefcenterId}.
        slots:
          Purposes: requestBody.Purposes
          identifier: query.identifier
          prefcenterId: path.prefcenterId
      - text: Set preference center {prefcenterId} choices to {Purposes} for the subject in header {identifier}.
        slots:
          prefcenterId: path.prefcenterId
          Purposes: requestBody.Purposes
          identifier: header.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences'].delete
  update:
    x-apievangelist-phrasing:
      intent: Withdraw all consent in a preference center
      effect: destructive
      questions:
      - Can I withdraw someone's consent for every purpose in a preference center at once?
      - Is the notification opt-out purpose affected by a full withdrawal?
      instructions:
      - text: Withdraw all consent for {identifier} in preference center {prefcenterId}.
        slots:
          identifier: query.identifier
          prefcenterId: path.prefcenterId
      - text: Opt {identifier} out of every purpose in preference center {prefcenterId}.
        slots:
          identifier: header.identifier
          prefcenterId: path.prefcenterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/preferencecenters/{prefcenterId}/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a preference center's schema
      effect: read
      questions:
      - What purposes, languages and settings does a preference center have?
      - Can I fetch a preference center's configuration in a certain state?
      instructions:
      - text: Get the schema of preference center {prefcenterId}.
        slots:
          prefcenterId: path.prefcenterId
      - text: Show the {state} configuration of preference center {prefcenterId}.
        slots:
          state: query.state
          prefcenterId: path.prefcenterId
      method: generated
      generated: '2026-09-26'