# 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-purpose-preferences-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/custompreferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List purpose preferences
      effect: read
      questions:
      - Which Purpose Preferences are set up, and how many options does each have?
      - Can I sort the Purpose Preferences list?
      instructions:
      - text: List all Purpose Preferences.
      - text: List Purpose Preferences sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/custompreferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a purpose preference
      effect: write
      questions:
      - Can I create a Purpose Preference with its own options, like topics or frequency?
      - Is it possible to make a preference single-select or multi-select?
      instructions:
      - text: 'Create Purpose Preference {Name}: {Description}, selection {SelectionType}, display {DisplayAs}, language {Language}, options {Options}.'
        slots:
          Name: requestBody.Name
          Description: requestBody.Description
          SelectionType: requestBody.SelectionType
          DisplayAs: requestBody.DisplayAs
          Language: requestBody.Language
          Options: requestBody.Options
      - text: Add a new preference named {Name} with options {Options}.
        slots:
          Name: requestBody.Name
          Options: requestBody.Options
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/custompreferences/{customPreferenceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a purpose preference
      effect: write
      questions:
      - Can I rename a Purpose Preference or change its options?
      - Is it possible to disable a Purpose Preference?
      instructions:
      - text: Update Purpose Preference {customPreferenceId} (Id {Id}) with name {Name}, selection {SelectionType}, display {DisplayAs}.
        slots:
          customPreferenceId: path.customPreferenceId
          Id: requestBody.Id
          Name: requestBody.Name
          SelectionType: requestBody.SelectionType
          DisplayAs: requestBody.DisplayAs
      - text: Disable preference {customPreferenceId}.
        slots:
          customPreferenceId: path.customPreferenceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/custompreferences/{custompreferenceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a purpose preference
      effect: read
      questions:
      - What languages and options does one Purpose Preference have?
      - Can I include translations when fetching a Purpose Preference?
      instructions:
      - text: Get Purpose Preference {custompreferenceId}.
        slots:
          custompreferenceId: path.custompreferenceId
      - text: Show preference {custompreferenceId} with translations {includeTranslations}.
        slots:
          custompreferenceId: path.custompreferenceId
          includeTranslations: query.includeTranslations
      method: generated
      generated: '2026-09-26'