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-collection-points-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: 5
- target: $.paths['/api/consentmanager/v1/collectionpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List consent Collection Points
      effect: read
      questions:
      - Which Collection Points are capturing consent across my sites and forms?
      - Can I filter Collection Points by purpose, type or status?
      instructions:
      - text: List Collection Points with status {status}.
        slots:
          status: query.status
      - text: Show Collection Points that collect consent for purpose {purposeGuid}.
        slots:
          purposeGuid: query.purposeGuid
      - text: Find the Collection Point named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/collectionpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft Collection Point
      effect: write
      questions:
      - How do I set up a new place to capture consent, like a web form?
      - What status does a newly created Collection Point start in?
      instructions:
      - text: Create a {CollectionPointType} Collection Point {Name} described as {Description} in organization {OrganizationId}.
        slots:
          CollectionPointType: requestBody.CollectionPointType
          Name: requestBody.Name
          Description: requestBody.Description
          OrganizationId: requestBody.OrganizationId
      - text: Add Collection Point {Name} ({CollectionPointType}, {Description}) for org {OrganizationId} with double opt-in {DoubleOptIn}.
        slots:
          Name: requestBody.Name
          CollectionPointType: requestBody.CollectionPointType
          Description: requestBody.Description
          OrganizationId: requestBody.OrganizationId
          DoubleOptIn: requestBody.DoubleOptIn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/collectionpoints/{collectionpointGuid}/token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JWT for a Collection Point
      effect: read
      questions:
      - Where do I get the token to send consent receipts for a Collection Point?
      - Can I get the token for a specific Collection Point version?
      instructions:
      - text: Get the JWT for Collection Point {collectionpointGuid}.
        slots:
          collectionpointGuid: path.collectionpointGuid
      - text: Fetch the version {version} token of Collection Point {collectionpointGuid}.
        slots:
          version: query.version
          collectionpointGuid: path.collectionpointGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/collectionpoints/{collectionpointId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a draft Collection Point
      effect: write
      questions:
      - How do I change a Collection Point that is still in draft?
      - Can I edit a Collection Point that is already active?
      instructions:
      - text: Update draft Collection Point {collectionpointId} with name {Name} and description {Description}.
        slots:
          collectionpointId: path.collectionpointId
          Name: requestBody.Name
          Description: requestBody.Description
      - text: Change the privacy policy URL of draft Collection Point {collectionpointId} to {PrivacyPolicyUrl}.
        slots:
          collectionpointId: path.collectionpointId
          PrivacyPolicyUrl: requestBody.PrivacyPolicyUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/collectionpoints/{collectionpointId}/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a Collection Point
      effect: write
      questions:
      - How do I stop a Collection Point from collecting consent?
      - Does disabling a Collection Point affect all of its versions?
      instructions:
      - text: Disable Collection Point {collectionpointId}.
        slots:
          collectionpointId: path.collectionpointId
      - text: Set the disabled flag of Collection Point {collectionpointId} to {value}.
        slots:
          collectionpointId: path.collectionpointId
          value: query.value
      method: generated
      generated: '2026-09-26'