ConsumerInfoRegistration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ivans/main/json-schema/ivans-consumer-info-registration-schema.json",
  "title": "ConsumerInfoRegistration",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ivans-exchange-v1-openapi.json#/components/schemas/ConsumerInfoRegistration",
  "required": [
    "account",
    "delay",
    "endpoint",
    "maxFileListSize",
    "userId"
  ],
  "type": "object",
  "properties": {
    "account": {
      "minLength": 1,
      "type": "string",
      "description": "mailbox account to register notifications for"
    },
    "userId": {
      "minLength": 1,
      "type": "string",
      "description": "mailbox userId to register notifications for"
    },
    "consumerPackage": {
      "type": [
        "string",
        "null"
      ],
      "description": "custom data to send with notification"
    },
    "delay": {
      "maximum": 2147483,
      "minimum": 0,
      "type": "integer",
      "description": "delay (in seconds) to wait between sending notifications for this registration",
      "format": "int32"
    },
    "maxFileListSize": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "description": "maximum number of notifications to send",
      "format": "int32"
    },
    "endpoint": {
      "minLength": 1,
      "type": "string",
      "description": "endpoint to post notifications to"
    },
    "headers": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "description": "custom headers to include in notification package"
    }
  },
  "additionalProperties": false
}