circuit_termination.py

"""
CircuitTermination entity examples for the Diode Python SDK.

This module demonstrates three patterns for ingesting CircuitTermination entities:
- circuit_termination_minimal: Required fields only
- circuit_termination_extended: Common optional fields
- circuit_termination_explicit: Fully nested objects with all fields
"""

from netboxlabs.diode.sdk import DiodeClient
from netboxlabs.diode.sdk.ingester import (
    Circuit,
    CircuitTermination,
    CircuitType,
    Entity,
    Location,
    Provider,
    ProviderNetwork,
    Region,
    Site,
    SiteGroup,
    Tag,
)

TARGET = "grpc://localhost:8080/diode"
APP_NAME = "circuit_termination-example"
APP_VERSION = "1.0.0"
CLIENT_ID = "diode"
CLIENT_SECRET = "changeme"


def main():
    """Main execution - demonstrates ingesting a CircuitTermination entity."""
    with DiodeClient(
        target=TARGET,
        app_name=APP_NAME,
        app_version=APP_VERSION,
        client_id=CLIENT_ID,
        client_secret=CLIENT_SECRET,
    ) as client:
        # Choose one of the three patterns:
        circuit_termination = circuit_termination_minimal()
        # circuit_termination = circuit_termination_extended()
        # circuit_termination = circuit_termination_explicit()

        response = client.ingest(
            entities=[Entity(circuit_termination=circuit_termination)]
        )
        if response.errors:
            print(f"Errors: {response.errors}")
        else:
            print("CircuitTermination ingested successfully")


def circuit_termination_minimal() -> CircuitTermination:
    """Create a CircuitTermination with only required fields using flat strings."""
    return CircuitTermination(
        circuit="Example Circuit",  # flat string -> Circuit
        term_side="A",
        metadata={"source": "example"},
    )


def circuit_termination_extended() -> CircuitTermination:
    """Create a CircuitTermination with common optional fields."""
    return CircuitTermination(
        circuit="Example Circuit",
        term_side="A",
        metadata={"source": "example", "custom_key": "custom_value"},
        description="Example description",
        port_speed=1,
        upstream_speed=1,
        xconnect_id="Example Xconnect Id",
        pp_info="Example Pp Info",
        mark_connected=True,
    )


def circuit_termination_explicit() -> CircuitTermination:
    """Create a CircuitTermination with fully nested objects and all common fields."""
    return CircuitTermination(
        circuit=Circuit(
            cid="CID-001",
            provider=Provider(
                name="Example Name", slug="example-slug", metadata={"source": "example"}
            ),
            type=CircuitType(
                name="Example Name",
                slug="example-slug",
                color="0000ff",
                metadata={"source": "example"},
            ),
            status="active",
            metadata={"source": "example"},
        ),
        term_side="A",
        metadata={
            "source": "example",
            "custom_key": "custom_value",
            "collected_at": "2024-01-15T10:30:00Z",
        },
        description="Example description",
        port_speed=1,
        upstream_speed=1,
        xconnect_id="Example Xconnect Id",
        pp_info="Example Pp Info",
        mark_connected=True,
        # Polymorphic 'termination' — choose ONE of these mutually exclusive variants:
        termination_site=Site(
            name="Example Name",
            slug="example-slug",
            status="active",
            metadata={"source": "example"},
        ),
        # termination_location=Location(name="Example Name", slug="example-slug", site=Site(name="Example Name", slug="example-slug", status="active", metadata={"source": "example"}), status="active", metadata={"source": "example"}),
        # termination_provider_network=ProviderNetwork(provider=Provider(name="Example Name", slug="example-slug", metadata={"source": "example"}), name="Example Name", metadata={"source": "example"}),
        # termination_region=Region(name="Example Name", slug="example-slug", metadata={"source": "example"}),
        # termination_site_group=SiteGroup(name="Example Name", slug="example-slug", metadata={"source": "example"}),
        tags=[Tag(name="production")],
    )


if __name__ == "__main__":
    main()