CatalogResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/hedgespecialty-com/json-schema/hedgespecialty-com-catalog-result-schema.json",
  "title": "CatalogResult",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hedgespecialty-com-openapi.yml#/components/schemas/CatalogResult",
  "type": "object",
  "required": [
    "catalog_version",
    "generated_at",
    "scope",
    "programs",
    "excluded"
  ],
  "properties": {
    "catalog_version": {
      "type": "string"
    },
    "generated_at": {
      "type": "string",
      "format": "date-time"
    },
    "scope": {
      "type": "object",
      "properties": {
        "lines": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "state": {
          "type": "string"
        },
        "exposure_states": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "naics": {
          "type": [
            "string",
            "null"
          ]
        },
        "brokerage_scoped": {
          "type": "boolean"
        },
        "all_channels": {
          "type": "boolean"
        }
      }
    },
    "programs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "program_id": {
            "type": "string",
            "format": "uuid"
          },
          "program_name": {
            "type": "string"
          },
          "market": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "slug": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "display_name": {
                "type": "string"
              },
              "logo_url": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          },
          "issuing_company": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "legal_name": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "naic": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "admitted": {
                "type": [
                  "boolean",
                  "null"
                ]
              },
              "am_best_rating": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          },
          "channel": {
            "type": "string",
            "enum": [
              "api",
              "portal",
              "email"
            ],
            "description": "`email` only with `all_channels`. `portal` covers the portals Hedge drives and, with `all_channels`, manual portals."
          },
          "group": {
            "type": "string",
            "enum": [
              "instant",
              "hedge"
            ],
            "description": "`instant` for `api`; `hedge` for `portal` and `email`."
          },
          "route_label": {
            "type": "string",
            "enum": [
              "Instant quote",
              "Hedge Binding",
              "Hedge Specialty"
            ],
            "description": "Small-print route name for `api`, `portal` and `email` respectively."
          },
          "appetite": {
            "$ref": "#/$defs/CatalogAppetite"
          },
          "lines": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "default_selected": {
            "type": "boolean"
          },
          "default_lines": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The lines this program is the default for. Pre-select each\ndefault program with exactly these lines (one program per\nmarket, channel and line). With `all_channels`, `hedge` rows\nare pre-selected only when `fit` and among Hedge's top picks\nfor the line (at most 8 per line, ranked by Hedge's market\nresults); `instant` rows keep one default per market and line.\n"
          },
          "alternative_of": {
            "type": [
              "string",
              "null"
            ],
            "format": "uuid",
            "description": "The sibling Hedge sends instead at the same market, channel and line; null for that primary program, pre-selected or not."
          },
          "speed": {
            "$ref": "#/$defs/SpeedHint"
          },
          "fit": {
            "type": "string",
            "enum": [
              "line_match"
            ]
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "bind_path": {
            "type": "string",
            "enum": [
              "hedge_portal"
            ]
          }
        }
      }
    },
    "excluded": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "program_id": {
            "type": "string",
            "format": "uuid"
          },
          "program_name": {
            "type": "string"
          },
          "market": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "display_name": {
                "type": "string"
              }
            }
          },
          "channel": {
            "type": "string",
            "enum": [
              "api",
              "portal",
              "email"
            ]
          },
          "group": {
            "type": "string",
            "enum": [
              "instant",
              "hedge"
            ]
          },
          "route_label": {
            "type": "string",
            "enum": [
              "Instant quote",
              "Hedge Binding",
              "Hedge Specialty"
            ]
          },
          "appetite": {
            "$ref": "#/$defs/CatalogAppetite"
          },
          "lines": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "reasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "$defs": {
    "CatalogAppetite": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "fit",
            "review",
            "excluded"
          ],
          "description": "`fit`: Hedge would send it (API and portal programs on line of\nbusiness; email programs whose published appetite matches the\nNAICS class). `review`: passes every line, state, class and\nbrokerage check, and Hedge reviews appetite before sending (the\nusual email case). `excluded`: a check fails (rows in `excluded`\nonly).\n"
        },
        "reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "Plain-English reason to show when present."
        }
      }
    },
    "SpeedHint": {
      "type": "object",
      "description": "A channel-level expectation (`basis` is `channel_default`), never a per-program promise.",
      "required": [
        "hint",
        "label",
        "basis"
      ],
      "properties": {
        "hint": {
          "type": "string",
          "enum": [
            "minutes",
            "within_day",
            "underwriter_review"
          ]
        },
        "label": {
          "type": "string"
        },
        "basis": {
          "type": "string",
          "enum": [
            "channel_default"
          ]
        }
      }
    }
  }
}