{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/delinea/main/json-schema/delinea-paging-of-inbox-message-summary-schema.json",
  "title": "PagingOfInboxMessageSummary",
  "description": "Specify paging and sorting options for querying records and returning results",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/delinea-inbox-api-openapi.yml#/components/schemas/PagingOfInboxMessageSummary",
  "properties": {
    "batchCount": {
      "description": "Number of result batches available with current query options",
      "type": "integer",
      "format": "int32"
    },
    "currentPage": {
      "description": "Index of current result page",
      "type": "integer",
      "format": "int32"
    },
    "hasNext": {
      "description": "Whether there are any results in additional pages",
      "type": "boolean"
    },
    "hasPrev": {
      "description": "Whether there are any results in previous pages",
      "type": "boolean"
    },
    "nextSkip": {
      "description": "Correct value of 'skip' for the next page of results",
      "type": "integer",
      "format": "int32"
    },
    "pageCount": {
      "description": "Number of result pages available with current query options",
      "type": "integer",
      "format": "int32"
    },
    "prevSkip": {
      "description": "Correct value of 'skip' for the previous page of results",
      "type": "integer",
      "format": "int32"
    },
    "records": {
      "description": "Query results",
      "items": {
        "$ref": "#/$defs/InboxMessageSummary"
      },
      "type": "array"
    },
    "severity": {
      "$ref": "#/$defs/Severity"
    },
    "skip": {
      "description": "Number of records to skip before taking results",
      "type": "integer",
      "format": "int32"
    },
    "sortBy": {
      "description": "List of sort properties",
      "items": {
        "$ref": "#/$defs/Sort"
      },
      "type": "array"
    },
    "success": {
      "description": "Whether the query executed successfully",
      "type": "boolean"
    },
    "take": {
      "description": "Maximum number of records to include in results",
      "type": "integer",
      "format": "int32"
    },
    "total": {
      "description": "Total number of results available",
      "type": "integer",
      "format": "int32"
    }
  },
  "type": "object",
  "$defs": {
    "InboxMessageData": {
      "description": "All data fields for this messages",
      "properties": {
        "displayValue": {
          "description": "DisplayValue",
          "type": "string"
        },
        "inboxDataId": {
          "description": "InboxDataId",
          "type": "integer",
          "format": "int32"
        },
        "inboxDataName": {
          "description": "InboxDataName",
          "type": "string"
        },
        "valueBool": {
          "description": "ValueBool",
          "type": [
            "boolean",
            "null"
          ]
        },
        "valueDateTime": {
          "description": "ValueDateTime",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "valueInt": {
          "description": "ValueInt",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "valueString": {
          "description": "ValueString",
          "type": "string"
        }
      },
      "type": "object"
    },
    "InboxMessageSummary": {
      "description": "Summary of an inbox message",
      "properties": {
        "data": {
          "description": "All data fields for this messages",
          "items": {
            "$ref": "#/$defs/InboxMessageData"
          },
          "type": "array"
        },
        "details": {
          "description": "A common data field on all notifications",
          "type": "string"
        },
        "expirationDate": {
          "description": "Within 24 hours of this date this message and all related history will be removed",
          "type": "string",
          "format": "date-time"
        },
        "inboxMessageTypeId": {
          "description": "The type of message id",
          "type": "integer",
          "format": "int32"
        },
        "inboxMessageTypeName": {
          "description": "The message type name",
          "type": "string"
        },
        "isRead": {
          "description": "Has the current user read this message",
          "type": "boolean"
        },
        "messageCreatedDate": {
          "description": "When was the message created",
          "type": "string",
          "format": "date-time"
        },
        "messageId": {
          "description": "Message ID",
          "type": "integer",
          "format": "int32"
        },
        "recipients": {
          "description": "Who has recieved this message",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "Severity": {
      "description": "Error severity level",
      "properties": {},
      "type": "string",
      "enum": [
        "None",
        "Retry",
        "Warn",
        "Critical",
        "Fatal"
      ]
    },
    "Sort": {
      "description": "Sort options. Multiple sort options can be provided in the query string.",
      "required": [
        "name",
        "direction"
      ],
      "properties": {
        "direction": {
          "$ref": "#/$defs/SortDirection"
        },
        "name": {
          "description": "Sort field name",
          "type": "string"
        },
        "priority": {
          "description": "Priority index. Sorts with lower values are executed earlier",
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "SortDirection": {
      "description": "Sort direction",
      "properties": {},
      "type": "string",
      "enum": [
        "None",
        "Asc",
        "Desc"
      ]
    }
  }
}