# 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 Message Audits API
  version: 1.0.0
extends: openapi/optimizely-message-audits-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/MessageAudits'].get
  update:
    x-apievangelist-phrasing:
      intent: List message audit entries
      effect: read
      questions:
      - How do I review the audit trail of messages sent between users?
      - Where can I see all message audit records?
      instructions:
      - text: List all message audit entries.
      - text: Show me the full message audit log.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageAudits'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a message audit entry
      effect: write
      questions:
      - How do I log a message audit entry for an order?
      - What does a message audit record need, such as process and body?
      instructions:
      - text: Record a message audit for process {process} with body {body}.
        slots:
          process: requestBody.process
          body: requestBody.body
      - text: Log an audit of message {messageId} on order {customerOrderId}, process {process}.
        slots:
          messageId: requestBody.messageId
          customerOrderId: requestBody.customerOrderId
          process: requestBody.process
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageAudits({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one message audit entry
      effect: read
      questions:
      - Is there a call to read a single message audit record?
      - Who sent and received the message in a specific audit entry?
      instructions:
      - text: Get message audit {id}.
        slots:
          id: path.id
      - text: Show sender and recipient on audit entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageAudits({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a message audit entry
      effect: write
      questions:
      - What's the call to overwrite a message audit record entirely?
      - Which fields must I resend when replacing an audit entry?
      instructions:
      - text: Replace message audit {id} with process {process} and body {body}.
        slots:
          id: path.id
          process: requestBody.process
          body: requestBody.body
      - text: Overwrite audit entry {id} in full for message {messageId}.
        slots:
          id: path.id
          messageId: requestBody.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageAudits({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message audit entry
      effect: destructive
      questions:
      - How do I remove a single message audit record?
      - Can I delete an audit entry only if its ETag hasn't changed?
      instructions:
      - text: Delete message audit {id}.
        slots:
          id: path.id
      - text: Delete audit entry {id} if ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageAudits({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a message audit entry
      effect: write
      questions:
      - How do I correct the recipient on a message audit record?
      - Can I change just the order linked to an audit entry?
      instructions:
      - text: Set the recipient of audit {id} to user {toUserProfileId}.
        slots:
          id: path.id
          toUserProfileId: requestBody.toUserProfileId
      - text: Link audit entry {id} to order {customerOrderId}.
        slots:
          id: path.id
          customerOrderId: requestBody.customerOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageAudits/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default message audit template
      effect: read
      questions:
      - What does a default message audit record look like?
      - Where do I get blank values for a new audit entry?
      instructions:
      - text: Get the default message audit template.
      - text: Show default fields for a new message audit.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/messageaudits/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete message audit entries
      effect: destructive
      questions:
      - Is it possible to purge many message audit records at once?
      - Can I bulk delete audit entries by ID?
      instructions:
      - text: Bulk delete message audits {ids}.
        slots:
          ids: query.ids
      - text: 'Purge these audit log entries: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/messageaudits({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a message audit
      effect: read
      questions:
      - Where would I read a custom property on a message audit record?
      - Can I fetch an extra attribute stored on an audit entry?
      instructions:
      - text: Get custom property {prop} on message audit {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      - text: Show custom field {prop} for message audit {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      method: generated
      generated: '2026-09-26'