# 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 Logs API
  version: 1.0.0
extends: openapi/optimizely-push-notification-logs-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: 9
- target: $.paths['/api/v1/admin/PushNotificationLogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List push notification delivery logs
      effect: read
      questions:
      - How can I see the delivery log for push notifications sent to devices?
      - Can I filter push notification logs to the ones that failed?
      instructions:
      - text: List all push notification logs.
      - text: Show push notification logs matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a push notification delivery attempt
      effect: write
      questions:
      - What goes into a push notification log entry?
      - Can I log a Firebase messaging error for a delivery attempt?
      instructions:
      - text: Log Firebase message {firebaseMessageId} with error code {messagingErrorCode} and message {errorMessage}.
        slots:
          firebaseMessageId: requestBody.firebaseMessageId
          messagingErrorCode: requestBody.messagingErrorCode
          errorMessage: requestBody.errorMessage
      - text: Record a push delivery for device token {deviceTokenId} as Firebase message {firebaseMessageId}.
        slots:
          deviceTokenId: requestBody.deviceTokenId
          firebaseMessageId: requestBody.firebaseMessageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationLogs({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one push notification log entry
      effect: read
      questions:
      - How do I look up one push notification log entry?
      - Why did a particular push notification fail to deliver?
      instructions:
      - text: Fetch push notification log {id}.
        slots:
          id: path.id
      - text: Show the error details on push log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationLogs({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a push notification log entry
      effect: write
      questions:
      - Can I overwrite an entire push notification log record?
      - Does replacing a push log require the Firebase id and error fields again?
      instructions:
      - text: Replace push log {id} with Firebase message {firebaseMessageId}.
        slots:
          id: path.id
          firebaseMessageId: requestBody.firebaseMessageId
      - text: Overwrite the full push notification log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationLogs({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single push notification log
      effect: destructive
      questions:
      - How do I delete one push notification log entry?
      - Can I delete a push log only if its ETag matches?
      instructions:
      - text: Delete push notification log {id}.
        slots:
          id: path.id
      - text: Delete push log {id} if the ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationLogs({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a push notification as delivered
      effect: write
      questions:
      - Can I update a push log with the date it was delivered?
      - Is there a way to correct the error message on an existing push log?
      instructions:
      - text: Set the delivered date on push log {id} to {deliveredDate}.
        slots:
          id: path.id
          deliveredDate: requestBody.deliveredDate
      - text: Update the error message on push log {id} to {errorMessage}.
        slots:
          id: path.id
          errorMessage: requestBody.errorMessage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PushNotificationLogs/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new push log
      effect: read
      questions:
      - What defaults does a new push notification log start with?
      - Is there a blank push log record template?
      instructions:
      - text: Get the default values for a new push notification log.
      - text: Show the empty push log record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pushnotificationlogs/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several push notification logs at once
      effect: destructive
      questions:
      - How do I bulk clear push notification logs?
      - Can I remove a list of push logs by id in one request?
      instructions:
      - text: Bulk delete push notification logs {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every push log in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pushnotificationlogs({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a push notification log
      effect: read
      questions:
      - How do I read a custom property on a push notification log?
      - Can I fetch one custom field from a push log entry?
      instructions:
      - text: Get custom property {custompropertyKey} of push log {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on push notification log {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'