ourskyai-node-platform-api 1.3.9821__py3-none-any.whl

ourskyai_node_platform_api/models/v1_system_events.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_system_event import V1SystemEvent
+
+class V1SystemEvents(BaseModel):
+    """
+    Container for a list of system events returned from an event query. Events are ordered by timestamp from most recent to oldest.  # noqa: E501
+    """
+    system_events: conlist(V1SystemEvent) = Field(..., alias="systemEvents", description="Array of system event objects matching the query criteria. May be empty if no events match the filters.")
+    __properties = ["systemEvents"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemEvents:
+        """Create an instance of V1SystemEvents from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in system_events (list)
+        _items = []
+        if self.system_events:
+            for _item in self.system_events:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['systemEvents'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemEvents:
+        """Create an instance of V1SystemEvents from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemEvents.parse_obj(obj)
+
+        _obj = V1SystemEvents.parse_obj({
+            "system_events": [V1SystemEvent.from_dict(_item) for _item in obj.get("systemEvents")] if obj.get("systemEvents") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_health_check.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Optional
+from pydantic import BaseModel, Field, StrictBool, StrictStr
+from ourskyai_node_platform_api.models.v1_system_variant import V1SystemVariant
+
+class V1SystemHealthCheck(BaseModel):
+    """
+    Represents the health status and version information of the edge controller. Used for monitoring system health and verifying firmware compatibility.  # noqa: E501
+    """
+    healthy: StrictBool = Field(..., description="True if the edge controller is healthy.")
+    message: StrictStr = Field(..., description="A message providing additional information about the health status.")
+    version: StrictStr = Field(..., description="The software version of the edge controller.")
+    hardware_version: StrictStr = Field(..., alias="hardwareVersion", description="The hardware version of the edge controller.")
+    habitat_firmware_version: StrictStr = Field(..., alias="habitatFirmwareVersion", description="The firmware version of the habitat controller.")
+    system_variant: Optional[V1SystemVariant] = Field(None, alias="systemVariant")
+    lineage_id: Optional[StrictStr] = Field(None, alias="lineageId", description="Unique identifier for the lineage or configuration version of this system. Used for tracking configuration changes across deployments.")
+    serial_number: Optional[StrictStr] = Field(None, alias="serialNumber", description="Hardware serial number of the edge controller unit. Useful for inventory tracking and support identification.")
+    __properties = ["healthy", "message", "version", "hardwareVersion", "habitatFirmwareVersion", "systemVariant", "lineageId", "serialNumber"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemHealthCheck:
+        """Create an instance of V1SystemHealthCheck from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemHealthCheck:
+        """Create an instance of V1SystemHealthCheck from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemHealthCheck.parse_obj(obj)
+
+        _obj = V1SystemHealthCheck.parse_obj({
+            "healthy": obj.get("healthy"),
+            "message": obj.get("message"),
+            "version": obj.get("version"),
+            "hardware_version": obj.get("hardwareVersion"),
+            "habitat_firmware_version": obj.get("habitatFirmwareVersion"),
+            "system_variant": obj.get("systemVariant"),
+            "lineage_id": obj.get("lineageId"),
+            "serial_number": obj.get("serialNumber")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_location.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+from ourskyai_node_platform_api.models.v1_system_location_gps_details import V1SystemLocationGpsDetails
+
+class V1SystemLocation(BaseModel):
+    """
+    Geographic location of the telescope site used for astronomical calculations including coordinate transformations and observation planning.  # noqa: E501
+    """
+    latitude_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="latitudeDegrees", description="Geographic latitude of the telescope site in decimal degrees. Positive values indicate North latitude, negative values indicate South latitude. Range is -90 to +90.")
+    longitude_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="longitudeDegrees", description="Geographic longitude of the telescope site in decimal degrees. Positive values indicate East longitude, negative values indicate West longitude. Range is -180 to +180.")
+    height_meters: Union[StrictFloat, StrictInt] = Field(..., alias="heightMeters", description="Altitude of the telescope site above mean sea level in meters. Used for atmospheric refraction calculations and precise coordinate transformations.")
+    updated_at: datetime = Field(..., alias="updatedAt", description="ISO 8601 timestamp of when the location was last updated. Useful for determining data freshness when using GPS-derived positions.")
+    gps_details: Optional[V1SystemLocationGpsDetails] = Field(None, alias="gpsDetails")
+    __properties = ["latitudeDegrees", "longitudeDegrees", "heightMeters", "updatedAt", "gpsDetails"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemLocation:
+        """Create an instance of V1SystemLocation from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of gps_details
+        if self.gps_details:
+            _dict['gpsDetails'] = self.gps_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemLocation:
+        """Create an instance of V1SystemLocation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemLocation.parse_obj(obj)
+
+        _obj = V1SystemLocation.parse_obj({
+            "latitude_degrees": obj.get("latitudeDegrees"),
+            "longitude_degrees": obj.get("longitudeDegrees"),
+            "height_meters": obj.get("heightMeters"),
+            "updated_at": obj.get("updatedAt"),
+            "gps_details": V1SystemLocationGpsDetails.from_dict(obj.get("gpsDetails")) if obj.get("gpsDetails") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_location_gps_details.py

@@ -0,0 +1,77 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class V1SystemLocationGpsDetails(BaseModel):
+    """
+    Detailed GPS fix information including accuracy metrics and satellite visibility. Provides insight into the quality and reliability of the GPS position.  # noqa: E501
+    """
+    fix: StrictInt = Field(..., description="GPS fix type indicating position quality. Common values are 0 for no fix, 1 for 2D fix, and 2 for 3D fix. Higher values indicate better positioning accuracy.")
+    position_error_meters: Union[StrictFloat, StrictInt] = Field(..., alias="positionErrorMeters", description="Estimated horizontal position error in meters. Lower values indicate more accurate positioning. Useful for determining if GPS accuracy meets requirements.")
+    satellites_used: StrictInt = Field(..., alias="satellitesUsed", description="Number of GPS satellites currently used in the position calculation. More satellites generally result in better accuracy and reliability.")
+    satellites_visible: StrictInt = Field(..., alias="satellitesVisible", description="Total number of GPS satellites visible to the receiver. This may be higher than satellites used due to signal quality or geometry constraints.")
+    __properties = ["fix", "positionErrorMeters", "satellitesUsed", "satellitesVisible"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemLocationGpsDetails:
+        """Create an instance of V1SystemLocationGpsDetails from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemLocationGpsDetails:
+        """Create an instance of V1SystemLocationGpsDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemLocationGpsDetails.parse_obj(obj)
+
+        _obj = V1SystemLocationGpsDetails.parse_obj({
+            "fix": obj.get("fix"),
+            "position_error_meters": obj.get("positionErrorMeters"),
+            "satellites_used": obj.get("satellitesUsed"),
+            "satellites_visible": obj.get("satellitesVisible")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_metric.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import List, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist
+from ourskyai_node_platform_api.models.v1_system_metric_tag import V1SystemMetricTag
+from ourskyai_node_platform_api.models.v1_system_metric_type import V1SystemMetricType
+
+class V1SystemMetric(BaseModel):
+    """
+    Represents a single metric data point with its value, type, timestamp, and associated tags for categorization.  # noqa: E501
+    """
+    name: StrictStr = Field(..., description="The metric identifier that describes what is being measured, such as cpu_temperature or mount_position_altitude.")
+    value: Union[StrictFloat, StrictInt] = Field(..., description="The numeric measurement value. The interpretation depends on the metric type and name. Units are metric-specific.")
+    type: V1SystemMetricType = Field(...)
+    measured_at: datetime = Field(..., alias="measuredAt", description="ISO 8601 timestamp indicating when this measurement was taken. Essential for time-series analysis and correlation.")
+    tags: conlist(V1SystemMetricTag) = Field(..., description="Additional metadata tags that provide context for this metric, enabling filtering by component, sensor, or other dimensions.")
+    __properties = ["name", "value", "type", "measuredAt", "tags"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemMetric:
+        """Create an instance of V1SystemMetric from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in tags (list)
+        _items = []
+        if self.tags:
+            for _item in self.tags:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['tags'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemMetric:
+        """Create an instance of V1SystemMetric from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemMetric.parse_obj(obj)
+
+        _obj = V1SystemMetric.parse_obj({
+            "name": obj.get("name"),
+            "value": obj.get("value"),
+            "type": obj.get("type"),
+            "measured_at": obj.get("measuredAt"),
+            "tags": [V1SystemMetricTag.from_dict(_item) for _item in obj.get("tags")] if obj.get("tags") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_metric_names.py

@@ -0,0 +1,71 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List
+from pydantic import BaseModel, Field, StrictStr, conlist
+
+class V1SystemMetricNames(BaseModel):
+    """
+    Contains the list of all available metric identifiers that can be queried from the system for telemetry and monitoring purposes.  # noqa: E501
+    """
+    metric_names: conlist(StrictStr) = Field(..., alias="metricNames", description="Array of metric name strings identifying all available telemetry data points. Use these names when querying the metrics endpoint.")
+    __properties = ["metricNames"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemMetricNames:
+        """Create an instance of V1SystemMetricNames from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemMetricNames:
+        """Create an instance of V1SystemMetricNames from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemMetricNames.parse_obj(obj)
+
+        _obj = V1SystemMetricNames.parse_obj({
+            "metric_names": obj.get("metricNames")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_metric_tag.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, Field, StrictStr
+
+class V1SystemMetricTag(BaseModel):
+    """
+    A key-value pair that provides additional context and categorization for a metric data point. Tags enable filtering and grouping of metrics by various dimensions.  # noqa: E501
+    """
+    name: StrictStr = Field(..., description="The tag key or dimension name, such as camera_id, component, or sensor_type. Used for filtering and grouping metrics.")
+    value: StrictStr = Field(..., description="The value associated with this tag key. For example, if name is camera_id, this would contain the specific camera identifier.")
+    __properties = ["name", "value"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemMetricTag:
+        """Create an instance of V1SystemMetricTag from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemMetricTag:
+        """Create an instance of V1SystemMetricTag from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemMetricTag.parse_obj(obj)
+
+        _obj = V1SystemMetricTag.parse_obj({
+            "name": obj.get("name"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_metric_type.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import json
+import pprint
+import re  # noqa: F401
+from aenum import Enum, no_arg
+
+
+
+
+
+class V1SystemMetricType(str, Enum):
+    """
+    Specifies the type of metric measurement, which determines how the value should be interpreted and aggregated.
+    """
+
+    """
+    allowed enum values
+    """
+    GAUGE = 'GAUGE'
+    COUNT = 'COUNT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemMetricType:
+        """Create an instance of V1SystemMetricType from a JSON string"""
+        return V1SystemMetricType(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_system_metrics.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_system_metric import V1SystemMetric
+
+class V1SystemMetrics(BaseModel):
+    """
+    Container for an array of metric data points returned from a metrics query. Used for time-series analysis and system monitoring.  # noqa: E501
+    """
+    metrics: conlist(V1SystemMetric) = Field(..., description="Array of metric data points matching the query criteria. May be empty if no metrics match the specified filters.")
+    __properties = ["metrics"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemMetrics:
+        """Create an instance of V1SystemMetrics from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
+        _items = []
+        if self.metrics:
+            for _item in self.metrics:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['metrics'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemMetrics:
+        """Create an instance of V1SystemMetrics from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemMetrics.parse_obj(obj)
+
+        _obj = V1SystemMetrics.parse_obj({
+            "metrics": [V1SystemMetric.from_dict(_item) for _item in obj.get("metrics")] if obj.get("metrics") is not None else None
+        })
+        return _obj
+
+