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

ourskyai_node_platform_api/models/update_custom_image_processing_container_request.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 typing import Optional
+from pydantic import BaseModel, Field, StrictBool, StrictStr
+
+class UpdateCustomImageProcessingContainerRequest(BaseModel):
+    """
+    UpdateCustomImageProcessingContainerRequest
+    """
+    image_friendly_name: Optional[StrictStr] = Field(None, alias="imageFriendlyName", description="The friendly name of the custom image processing container.")
+    active: Optional[StrictBool] = Field(None, description="If true, the container will run and receive images from the primary pipeline. If false, the container will not run.")
+    __properties = ["imageFriendlyName", "active"]
+
+    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) -> UpdateCustomImageProcessingContainerRequest:
+        """Create an instance of UpdateCustomImageProcessingContainerRequest 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) -> UpdateCustomImageProcessingContainerRequest:
+        """Create an instance of UpdateCustomImageProcessingContainerRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return UpdateCustomImageProcessingContainerRequest.parse_obj(obj)
+
+        _obj = UpdateCustomImageProcessingContainerRequest.parse_obj({
+            "image_friendly_name": obj.get("imageFriendlyName"),
+            "active": obj.get("active")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_all_sky_classification.py

@@ -0,0 +1,74 @@
+# 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
+from ourskyai_node_platform_api.models.v1_all_sky_classification_label import V1AllSkyClassificationLabel
+
+class V1AllSkyClassification(BaseModel):
+    """
+    Machine learning classification result for an all-sky image. Contains both the predicted sky condition label and a confidence score indicating how certain the model is about its prediction.  # noqa: E501
+    """
+    label: V1AllSkyClassificationLabel = Field(...)
+    confidence: Union[StrictFloat, StrictInt] = Field(..., description="Model confidence score ranging from 0.0 to 1.0. Higher values indicate greater certainty in the classification. A score above 0.8 typically indicates a reliable prediction.")
+    __properties = ["label", "confidence"]
+
+    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) -> V1AllSkyClassification:
+        """Create an instance of V1AllSkyClassification 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) -> V1AllSkyClassification:
+        """Create an instance of V1AllSkyClassification from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1AllSkyClassification.parse_obj(obj)
+
+        _obj = V1AllSkyClassification.parse_obj({
+            "label": obj.get("label"),
+            "confidence": obj.get("confidence")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_all_sky_classification_label.py

@@ -0,0 +1,43 @@
+# 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 V1AllSkyClassificationLabel(str, Enum):
+    """
+    Machine learning classification label indicating the sky condition observed in an all-sky image. These labels are determined by analyzing the image for cloud coverage and precipitation indicators.
+    """
+
+    """
+    allowed enum values
+    """
+    CLEAR = 'CLEAR'
+    LIGHT_CLOUDS = 'LIGHT_CLOUDS'
+    HEAVY_CLOUDS = 'HEAVY_CLOUDS'
+    PRECIPITATION = 'PRECIPITATION'
+    UNKNOWN = 'UNKNOWN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1AllSkyClassificationLabel:
+        """Create an instance of V1AllSkyClassificationLabel from a JSON string"""
+        return V1AllSkyClassificationLabel(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_all_sky_image.py

@@ -0,0 +1,81 @@
+# 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
+from ourskyai_node_platform_api.models.v1_all_sky_classification import V1AllSkyClassification
+from ourskyai_node_platform_api.models.v1_image import V1Image
+
+class V1AllSkyImage(BaseModel):
+    """
+    An all-sky camera image combined with its weather classification. Provides both the standard image metadata and the machine learning analysis of sky conditions at the time of capture.  # noqa: E501
+    """
+    image: V1Image = Field(...)
+    classification: V1AllSkyClassification = Field(...)
+    __properties = ["image", "classification"]
+
+    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) -> V1AllSkyImage:
+        """Create an instance of V1AllSkyImage 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 image
+        if self.image:
+            _dict['image'] = self.image.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of classification
+        if self.classification:
+            _dict['classification'] = self.classification.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1AllSkyImage:
+        """Create an instance of V1AllSkyImage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1AllSkyImage.parse_obj(obj)
+
+        _obj = V1AllSkyImage.parse_obj({
+            "image": V1Image.from_dict(obj.get("image")) if obj.get("image") is not None else None,
+            "classification": V1AllSkyClassification.from_dict(obj.get("classification")) if obj.get("classification") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_all_sky_images.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_all_sky_image import V1AllSkyImage
+
+class V1AllSkyImages(BaseModel):
+    """
+    Container object holding a paginated list of all-sky images with their weather classifications. Use the before parameter with the last image's createdAt timestamp to retrieve the next page.  # noqa: E501
+    """
+    all_sky_images: conlist(V1AllSkyImage) = Field(..., alias="allSkyImages", description="Array of all-sky image objects sorted by creation time in descending order (newest first). Each object includes both image metadata and weather classification results.")
+    __properties = ["allSkyImages"]
+
+    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) -> V1AllSkyImages:
+        """Create an instance of V1AllSkyImages 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 all_sky_images (list)
+        _items = []
+        if self.all_sky_images:
+            for _item in self.all_sky_images:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['allSkyImages'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1AllSkyImages:
+        """Create an instance of V1AllSkyImages from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1AllSkyImages.parse_obj(obj)
+
+        _obj = V1AllSkyImages.parse_obj({
+            "all_sky_images": [V1AllSkyImage.from_dict(_item) for _item in obj.get("allSkyImages")] if obj.get("allSkyImages") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_all_sky_keogram.py

@@ -0,0 +1,81 @@
+# 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 pydantic import BaseModel, Field, StrictStr
+
+class V1AllSkyKeogram(BaseModel):
+    """
+    Metadata for an all-sky keogram image. A keogram is a composite image created by extracting and stacking a vertical slice from each all-sky image over time, showing how sky conditions evolved throughout an observing period in a single image.  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Unique identifier for this keogram image. Use this ID for any keogram-specific operations or references.")
+    description: StrictStr = Field(..., description="Human-readable description of the keogram, typically including the date range and a summary of weather conditions observed.")
+    url: StrictStr = Field(..., description="Direct URL to download the keogram image file. Keograms are typically stored as JPEG or PNG images.")
+    started_at: datetime = Field(..., alias="startedAt", description="ISO 8601 timestamp of the first all-sky image included in this keogram, representing the left edge of the composite.")
+    ended_at: datetime = Field(..., alias="endedAt", description="ISO 8601 timestamp of the last all-sky image included in this keogram, representing the right edge of the composite.")
+    created_at: datetime = Field(..., alias="createdAt", description="ISO 8601 timestamp indicating when this keogram was generated. Used for pagination with the before parameter.")
+    __properties = ["id", "description", "url", "startedAt", "endedAt", "createdAt"]
+
+    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) -> V1AllSkyKeogram:
+        """Create an instance of V1AllSkyKeogram 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) -> V1AllSkyKeogram:
+        """Create an instance of V1AllSkyKeogram from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1AllSkyKeogram.parse_obj(obj)
+
+        _obj = V1AllSkyKeogram.parse_obj({
+            "id": obj.get("id"),
+            "description": obj.get("description"),
+            "url": obj.get("url"),
+            "started_at": obj.get("startedAt"),
+            "ended_at": obj.get("endedAt"),
+            "created_at": obj.get("createdAt")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_all_sky_keograms.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_all_sky_keogram import V1AllSkyKeogram
+
+class V1AllSkyKeograms(BaseModel):
+    """
+    Container object holding a paginated list of all-sky keogram images. Use the before parameter with the last keogram's createdAt timestamp to retrieve the next page.  # noqa: E501
+    """
+    all_sky_keograms: conlist(V1AllSkyKeogram) = Field(..., alias="allSkyKeograms", description="Array of keogram metadata objects sorted by creation time in descending order (newest first).")
+    __properties = ["allSkyKeograms"]
+
+    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) -> V1AllSkyKeograms:
+        """Create an instance of V1AllSkyKeograms 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 all_sky_keograms (list)
+        _items = []
+        if self.all_sky_keograms:
+            for _item in self.all_sky_keograms:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['allSkyKeograms'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1AllSkyKeograms:
+        """Create an instance of V1AllSkyKeograms from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1AllSkyKeograms.parse_obj(obj)
+
+        _obj = V1AllSkyKeograms.parse_obj({
+            "all_sky_keograms": [V1AllSkyKeogram.from_dict(_item) for _item in obj.get("allSkyKeograms")] if obj.get("allSkyKeograms") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_all_sky_prediction_label.py

@@ -0,0 +1,43 @@
+# 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 V1AllSkyPredictionLabel(str, Enum):
+    """
+    V1AllSkyPredictionLabel
+    """
+
+    """
+    allowed enum values
+    """
+    CLEAR = 'CLEAR'
+    LIGHT_CLOUDS = 'LIGHT_CLOUDS'
+    HEAVY_CLOUDS = 'HEAVY_CLOUDS'
+    PRECIPITATION = 'PRECIPITATION'
+    UNKNOWN = 'UNKNOWN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1AllSkyPredictionLabel:
+        """Create an instance of V1AllSkyPredictionLabel from a JSON string"""
+        return V1AllSkyPredictionLabel(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_all_sky_timelapse.py

@@ -0,0 +1,81 @@
+# 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 pydantic import BaseModel, Field, StrictStr
+
+class V1AllSkyTimelapse(BaseModel):
+    """
+    Metadata for an all-sky timelapse video. Timelapses are compiled from sequential all-sky images and show sky conditions changing over time, useful for reviewing weather patterns and identifying observing windows.  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Unique identifier for this timelapse video. Use this ID for any timelapse-specific operations or references.")
+    description: StrictStr = Field(..., description="Human-readable description of the timelapse, typically including the date range and any notable weather events observed.")
+    url: StrictStr = Field(..., description="Direct URL to download or stream the timelapse video file. The video is typically in MP4 format suitable for web playback.")
+    started_at: datetime = Field(..., alias="startedAt", description="ISO 8601 timestamp of the first all-sky image included in this timelapse sequence.")
+    ended_at: datetime = Field(..., alias="endedAt", description="ISO 8601 timestamp of the last all-sky image included in this timelapse sequence.")
+    created_at: datetime = Field(..., alias="createdAt", description="ISO 8601 timestamp indicating when this timelapse was generated. Used for pagination with the before parameter.")
+    __properties = ["id", "description", "url", "startedAt", "endedAt", "createdAt"]
+
+    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) -> V1AllSkyTimelapse:
+        """Create an instance of V1AllSkyTimelapse 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) -> V1AllSkyTimelapse:
+        """Create an instance of V1AllSkyTimelapse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1AllSkyTimelapse.parse_obj(obj)
+
+        _obj = V1AllSkyTimelapse.parse_obj({
+            "id": obj.get("id"),
+            "description": obj.get("description"),
+            "url": obj.get("url"),
+            "started_at": obj.get("startedAt"),
+            "ended_at": obj.get("endedAt"),
+            "created_at": obj.get("createdAt")
+        })
+        return _obj
+
+