# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Strivacity Notification Policy API
  version: 1.0.0
extends: openapi/strivacity-notification-policy-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: 7
- target: $.paths['/admin/api/v1/admin/notificationPolicy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the admin notification policy
      effect: read
      questions:
      - What sender address do admin notification emails come from?
      - Can I see the admin notification policy?
      instructions:
      - text: Show the admin notification policy.
      - text: Get the sender settings for admin notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/notificationPolicy'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the admin notification policy
      effect: write
      questions:
      - How do I change the sender of admin notification emails?
      - Can I set a display name for admin notification messages?
      instructions:
      - text: Set the admin notification sender to {sender}.
        slots:
          sender: requestBody.sender
      - text: Update admin notifications to come from {sender} as {senderDisplayName}.
        slots:
          sender: requestBody.sender
          senderDisplayName: requestBody.senderDisplayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification policies
      effect: read
      questions:
      - Which customer notification policies are defined?
      - Can I filter notification policies by name or tag?
      instructions:
      - text: List notification policies.
      - text: List notification policies tagged {policyTags}.
        slots:
          policyTags: query.policyTags
      - text: Find notification policies named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification policy
      effect: write
      questions:
      - How do I create a notification policy with its own sender address?
      - Can a new notification policy have a sender display name and tag?
      instructions:
      - text: Create notification policy {name} sending from {sender}.
        slots:
          name: requestBody.name
          sender: requestBody.sender
      - text: Create policy {name} with sender display name {senderDisplayName} and sender {sender}.
        slots:
          name: requestBody.name
          senderDisplayName: requestBody.senderDisplayName
          sender: requestBody.sender
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification policy
      effect: read
      questions:
      - What sender does a specific customer notification policy use?
      - Can I view one notification policy by ID?
      instructions:
      - text: Get notification policy {id}.
        slots:
          id: path.id
      - text: Show the sender settings of notification policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a notification policy
      effect: write
      questions:
      - Can I change the sender on an existing customer notification policy?
      - How do I rename a notification policy?
      instructions:
      - text: Update notification policy {id} to send from {sender}.
        slots:
          id: path.id
          sender: requestBody.sender
      - text: Rename notification policy {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/notificationPolicies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification policy
      effect: destructive
      questions:
      - Why can't I delete a notification policy that applications use?
      - How do I remove an unassigned notification policy?
      instructions:
      - text: Delete notification policy {id}.
        slots:
          id: path.id
      - text: Remove the unused notification policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'