MetadataOverviewResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-metadata-overview-response-schema.json",
  "title": "MetadataOverviewResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-session-analysis-api-openapi.yml#/components/schemas/MetadataOverviewResponse",
  "properties": {
    "meta": {
      "$ref": "#/$defs/MetadataInfo"
    },
    "query_parameters": {
      "additionalProperties": {
        "$ref": "#/$defs/QueryParameterInfo"
      },
      "description": "Map of supported query parameter names to their definitions.",
      "type": "object"
    },
    "record_types": {
      "items": {
        "$ref": "#/$defs/RecordTypeInfo"
      },
      "type": "array"
    }
  },
  "required": [
    "record_types",
    "query_parameters",
    "meta"
  ],
  "type": "object",
  "$defs": {
    "ChildRelationshipInfo": {
      "properties": {
        "child_event": {
          "type": "string"
        },
        "child_product": {
          "type": "string"
        },
        "child_record_type": {
          "type": "string"
        },
        "cost_rollup": {
          "type": "boolean"
        },
        "description": {
          "type": "string"
        },
        "relationship_type": {
          "type": "string"
        },
        "traversal_enabled": {
          "type": "boolean"
        },
        "via": {
          "$ref": "#/$defs/MetadataFieldMapping"
        }
      },
      "required": [
        "relationship_type",
        "via",
        "cost_rollup",
        "traversal_enabled",
        "description",
        "child_product",
        "child_event",
        "child_record_type"
      ],
      "type": "object"
    },
    "MetadataFieldMapping": {
      "properties": {
        "local_field": {
          "type": "string"
        },
        "parent_field": {
          "type": "string"
        }
      },
      "required": [
        "local_field",
        "parent_field"
      ],
      "type": "object"
    },
    "MetadataInfo": {
      "properties": {
        "last_updated": {
          "format": "date-time",
          "type": "string"
        },
        "total_record_types": {
          "type": "integer"
        }
      },
      "required": [
        "total_record_types",
        "last_updated"
      ],
      "type": "object"
    },
    "ParentRelationshipInfo": {
      "properties": {
        "cost_rollup": {
          "type": "boolean"
        },
        "description": {
          "type": "string"
        },
        "parent_event": {
          "type": "string"
        },
        "parent_product": {
          "type": "string"
        },
        "parent_record_type": {
          "type": "string"
        },
        "relationship_type": {
          "type": "string"
        },
        "traversal_enabled": {
          "type": "boolean"
        },
        "via": {
          "$ref": "#/$defs/MetadataFieldMapping"
        }
      },
      "required": [
        "relationship_type",
        "via",
        "cost_rollup",
        "traversal_enabled",
        "description",
        "parent_product",
        "parent_event",
        "parent_record_type"
      ],
      "type": "object"
    },
    "QueryParameterInfo": {
      "properties": {
        "default": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "enum_values": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "max": {
          "type": [
            "integer",
            "null"
          ]
        },
        "min": {
          "type": [
            "integer",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "default",
        "description"
      ],
      "type": "object"
    },
    "RecordTypeInfo": {
      "properties": {
        "aliases": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "child_relationships": {
          "items": {
            "$ref": "#/$defs/ChildRelationshipInfo"
          },
          "type": "array"
        },
        "description": {
          "type": "string"
        },
        "event": {
          "type": "string"
        },
        "parent_relationships": {
          "items": {
            "$ref": "#/$defs/ParentRelationshipInfo"
          },
          "type": "array"
        },
        "product": {
          "type": "string"
        },
        "record_type": {
          "type": "string"
        }
      },
      "required": [
        "record_type",
        "aliases",
        "product",
        "event",
        "description",
        "child_relationships",
        "parent_relationships"
      ],
      "type": "object"
    }
  }
}