# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Push Notification Messages API
  version: 1.0.0
extends: openapi/optimizely-push-notification-messages-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: 10
- target: $.paths['/api/v1/admin/PushNotificationMessages'].get
  update:
    x-apievangelist-phrasing:
      intent: List push notification messages
      effect: read
      questions:
      - Which push notifications have been sent to app users?
      - Can I filter push notification messages by type or sent date?
      instructions:
      - text: List all push notification messages.
      - text: Show push notification messages matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationMessages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a push notification message
      effect: write
      questions:
      - How do I create a push notification for a specific user?
      - What fields are required to create a push notification message?
      instructions:
      - text: Create a {type} push notification titled {title} with body {body} and data {data}.
        slots:
          type: requestBody.type
          title: requestBody.title
          body: requestBody.body
          data: requestBody.data
      - text: Send user {userProfileId} a push titled {title}, body {body}, type {type}, data {data}.
        slots:
          userProfileId: requestBody.userProfileId
          title: requestBody.title
          body: requestBody.body
          type: requestBody.type
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationMessages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a push notification message
      effect: read
      questions:
      - What did a particular push notification say and when was it sent?
      - Can I look up one push notification message by ID?
      instructions:
      - text: Get push notification message {id}.
        slots:
          id: path.id
      - text: Show the title and body of push message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationMessages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a push notification message
      effect: write
      questions:
      - How do I overwrite every field of a push notification message?
      - Can I fully replace a stored push notification?
      instructions:
      - text: Replace push message {id} with title {title}, body {body}, type {type}, data {data}.
        slots:
          id: path.id
          title: requestBody.title
          body: requestBody.body
          type: requestBody.type
          data: requestBody.data
      - text: Overwrite push notification {id} entirely using title {title}, body {body}, type {type} and data {data}.
        slots:
          id: path.id
          title: requestBody.title
          body: requestBody.body
          type: requestBody.type
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationMessages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a push notification message
      effect: destructive
      questions:
      - How do I delete one push notification message?
      - Does deleting a push message support an If-Match header?
      instructions:
      - text: Delete push notification message {id}.
        slots:
          id: path.id
      - text: Remove push message {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationMessages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a push notification message
      effect: write
      questions:
      - How do I edit the title of an existing push notification?
      - Can I change just the body text on a push message?
      instructions:
      - text: 'Update push message {id}: title {title}, body {body}, type {type}, data {data}.'
        slots:
          id: path.id
          title: requestBody.title
          body: requestBody.body
          type: requestBody.type
          data: requestBody.data
      - text: Patch push notification {id} so the title reads {title} (body {body}, type {type}, data {data}).
        slots:
          id: path.id
          title: requestBody.title
          body: requestBody.body
          type: requestBody.type
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationMessages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new push message
      effect: read
      questions:
      - What defaults does a new push notification message start with?
      - Is there a blank push notification template?
      instructions:
      - text: Get the default field values for a new push notification message.
      - text: Show a blank push notification record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pushnotificationmessages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several push notification messages
      effect: destructive
      questions:
      - How do I bulk delete old push notification messages?
      - Can I remove many push messages in one request?
      instructions:
      - text: Bulk delete push notification messages {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every push message in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pushnotificationmessages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a push message
      effect: read
      questions:
      - How do I read a custom property on a push notification message?
      - Can I fetch one custom field value from a push message?
      instructions:
      - text: Get custom property {custompropertyKey} of push message {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on push notification {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pushnotificationmessages({key})/pushnotificationlogs({pushnotificationlogKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a delivery log for a push message
      effect: read
      questions:
      - Was a push notification actually delivered? Where's its log?
      - Can I look up a specific delivery log entry for a push message?
      instructions:
      - text: Get log {pushnotificationlogKey} for push message {key}.
        slots:
          key: path.key
          pushnotificationlogKey: path.pushnotificationlogKey
      - text: Show delivery log entry {pushnotificationlogKey} of push notification {key}.
        slots:
          key: path.key
          pushnotificationlogKey: path.pushnotificationlogKey
      method: generated
      generated: '2026-09-26'