{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/daon/json-schema/daon-push-notification-summary-schema.json",
  "title": "PushNotificationSummary",
  "description": "Summary information about a push notification sent to a user.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/daon-user-push-notification-management-api-openapi.yml#/components/schemas/PushNotificationSummary",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Push notification record identifier.\nThe base-64 encoding of the key compressed using the zlib deflate algorithm."
    },
    "notificationType": {
      "type": "string",
      "description": "The type of push notification",
      "enum": [
        "TRUSTX",
        "GENERIC"
      ]
    },
    "notificationSubtype": {
      "type": "string",
      "description": "The subtype of push notification",
      "enum": [
        "APPKEY"
      ]
    },
    "notificationStatus": {
      "type": "string",
      "description": "The status of the push notification, whether it sent successfully or failed",
      "enum": [
        "SUCCESS",
        "FAIL"
      ]
    },
    "processInstanceId": {
      "type": "string",
      "description": "The process instance identifier associated with a TrustX push notification"
    },
    "processInstanceStatus": {
      "type": "string",
      "description": "The status of the process instance associated with a TrustX push notification if has its status monitored",
      "enum": [
        "PENDING",
        "IN_PROGRESS",
        "TIMED_OUT",
        "COMPLETE_SUCCESS",
        "COMPLETE_FAILED"
      ]
    },
    "rpId": {
      "type": "string",
      "description": "The relying party ID associated with the push notification"
    },
    "deviceId": {
      "type": "string",
      "description": "The device ID to which the push notification was sent"
    },
    "deviceName": {
      "type": "string",
      "description": "The name of the device to which the push notification was sent"
    },
    "deviceModel": {
      "type": "string",
      "description": "The model of the device to which the push notification was sent"
    },
    "osType": {
      "type": "string",
      "description": "The operating system type of the device to which the push notification was sent"
    },
    "createdDtm": {
      "type": "string",
      "format": "date-time",
      "description": "The created date time of the push notification record"
    },
    "content": {
      "$ref": "#/$defs/PushNotificationContent",
      "description": "Optional content of the push notification. Returned only if specifically requested using the includeContent parameter."
    }
  },
  "$defs": {
    "PushNotificationContent": {
      "type": "object",
      "description": "Contents of a push notification.",
      "properties": {
        "title": {
          "type": "string",
          "description": "A push notification title."
        },
        "message": {
          "type": "string",
          "description": "A push notification message."
        },
        "titleLocKey": {
          "type": "string",
          "description": "Optional key for a localisable push notification title."
        },
        "titleLocArgs": {
          "type": "array",
          "description": "Optional arguments for a localisable push notification title.",
          "items": {
            "type": "string"
          }
        },
        "messageLocKey": {
          "type": "string",
          "description": "Optional key for a localisable push notification message."
        },
        "messageLocArgs": {
          "type": "array",
          "description": "Optional arguments for a localisable push notification message.",
          "items": {
            "type": "string"
          }
        },
        "customProperties": {
          "type": "object",
          "additionalProperties": {
            "type": "object"
          },
          "description": "Optional custom properties to be included with the push notification."
        }
      }
    }
  }
}