across-server-openapi-python 0.0.1__py3-none-any.whl

across/sdk/v1/models/alt_az_constraint.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    ACROSS Server
+
+    Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
+
+    The version of the OpenAPI document: 0.3.2
+    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, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AltAzConstraint(BaseModel):
+    """
+    For a given Alt/Az constraint, is a given coordinate inside this constraint? Constraint is both defined by a polygon exclusion region and a minimum and maximum altitude. By default the minimum and maximum altitude values are 0 and 90 degrees respectively. Polygon restriction regions can be combined with minimum and maximum altitude restrictions.  Parameters ---------- polygon     The polygon defining the exclusion region. min     The minimum altitude in degrees. max     The maximum altitude in degrees.
+    """ # noqa: E501
+    short_name: Optional[StrictStr] = 'AltAz'
+    name: Optional[StrictStr] = 'Altitude/Azimuth Avoidance'
+    polygon: List[List[Union[StrictFloat, StrictInt]]]
+    altitude_min: Optional[Union[Annotated[float, Field(le=90.0, strict=True, ge=0.0)], Annotated[int, Field(le=90, strict=True, ge=0)]]] = None
+    altitude_max: Optional[Union[Annotated[float, Field(le=90.0, strict=True, ge=0.0)], Annotated[int, Field(le=90, strict=True, ge=0)]]] = None
+    azimuth_min: Optional[Union[Annotated[float, Field(strict=True, ge=0.0)], Annotated[int, Field(strict=True, ge=0)]]] = None
+    azimuth_max: Optional[Union[Annotated[float, Field(strict=True, ge=0.0)], Annotated[int, Field(strict=True, ge=0)]]] = None
+    __properties: ClassVar[List[str]] = ["short_name", "name", "polygon", "altitude_min", "altitude_max", "azimuth_min", "azimuth_max"]
+
+    @field_validator('name')
+    def name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Altitude/Azimuth Avoidance']):
+            raise ValueError("must be one of enum values ('Altitude/Azimuth Avoidance')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AltAzConstraint from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if altitude_min (nullable) is None
+        # and model_fields_set contains the field
+        if self.altitude_min is None and "altitude_min" in self.model_fields_set:
+            _dict['altitude_min'] = None
+
+        # set to None if altitude_max (nullable) is None
+        # and model_fields_set contains the field
+        if self.altitude_max is None and "altitude_max" in self.model_fields_set:
+            _dict['altitude_max'] = None
+
+        # set to None if azimuth_min (nullable) is None
+        # and model_fields_set contains the field
+        if self.azimuth_min is None and "azimuth_min" in self.model_fields_set:
+            _dict['azimuth_min'] = None
+
+        # set to None if azimuth_max (nullable) is None
+        # and model_fields_set contains the field
+        if self.azimuth_max is None and "azimuth_max" in self.model_fields_set:
+            _dict['azimuth_max'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AltAzConstraint from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "short_name": obj.get("short_name") if obj.get("short_name") is not None else 'AltAz',
+            "name": obj.get("name") if obj.get("name") is not None else 'Altitude/Azimuth Avoidance',
+            "polygon": obj.get("polygon"),
+            "altitude_min": obj.get("altitude_min"),
+            "altitude_max": obj.get("altitude_max"),
+            "azimuth_min": obj.get("azimuth_min"),
+            "azimuth_max": obj.get("azimuth_max")
+        })
+        return _obj
+
+

across/sdk/v1/models/bandpass.py

@@ -0,0 +1,149 @@
+# coding: utf-8
+
+"""
+    ACROSS Server
+
+    Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
+
+    The version of the OpenAPI document: 0.3.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from across.sdk.v1.models.energy_bandpass import EnergyBandpass
+from across.sdk.v1.models.frequency_bandpass import FrequencyBandpass
+from across.sdk.v1.models.wavelength_bandpass import WavelengthBandpass
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+BANDPASS_ANY_OF_SCHEMAS = ["EnergyBandpass", "FrequencyBandpass", "WavelengthBandpass"]
+
+class Bandpass(BaseModel):
+    """
+    Bandpass
+    """
+
+    # data type: EnergyBandpass
+    anyof_schema_1_validator: Optional[EnergyBandpass] = None
+    # data type: FrequencyBandpass
+    anyof_schema_2_validator: Optional[FrequencyBandpass] = None
+    # data type: WavelengthBandpass
+    anyof_schema_3_validator: Optional[WavelengthBandpass] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[EnergyBandpass, FrequencyBandpass, WavelengthBandpass]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "EnergyBandpass", "FrequencyBandpass", "WavelengthBandpass" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = Bandpass.model_construct()
+        error_messages = []
+        # validate data type: EnergyBandpass
+        if not isinstance(v, EnergyBandpass):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `EnergyBandpass`")
+        else:
+            return v
+
+        # validate data type: FrequencyBandpass
+        if not isinstance(v, FrequencyBandpass):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `FrequencyBandpass`")
+        else:
+            return v
+
+        # validate data type: WavelengthBandpass
+        if not isinstance(v, WavelengthBandpass):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `WavelengthBandpass`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in Bandpass with anyOf schemas: EnergyBandpass, FrequencyBandpass, WavelengthBandpass. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[EnergyBandpass] = None
+        try:
+            instance.actual_instance = EnergyBandpass.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[FrequencyBandpass] = None
+        try:
+            instance.actual_instance = FrequencyBandpass.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[WavelengthBandpass] = None
+        try:
+            instance.actual_instance = WavelengthBandpass.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into Bandpass with anyOf schemas: EnergyBandpass, FrequencyBandpass, WavelengthBandpass. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], EnergyBandpass, FrequencyBandpass, WavelengthBandpass]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

across/sdk/v1/models/bandpass_type.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+"""
+    ACROSS Server
+
+    Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
+
+    The version of the OpenAPI document: 0.3.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from across.sdk.v1.models.energy_unit import EnergyUnit
+from across.sdk.v1.models.frequency_unit import FrequencyUnit
+from across.sdk.v1.models.wavelength_unit import WavelengthUnit
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+BANDPASSTYPE_ANY_OF_SCHEMAS = ["EnergyUnit", "FrequencyUnit", "WavelengthUnit"]
+
+class BandpassType(BaseModel):
+    """
+    BandpassType
+    """
+
+    # data type: WavelengthUnit
+    anyof_schema_1_validator: Optional[WavelengthUnit] = None
+    # data type: EnergyUnit
+    anyof_schema_2_validator: Optional[EnergyUnit] = None
+    # data type: FrequencyUnit
+    anyof_schema_3_validator: Optional[FrequencyUnit] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[EnergyUnit, FrequencyUnit, WavelengthUnit]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "EnergyUnit", "FrequencyUnit", "WavelengthUnit" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        if v is None:
+            return v
+
+        instance = BandpassType.model_construct()
+        error_messages = []
+        # validate data type: WavelengthUnit
+        if not isinstance(v, WavelengthUnit):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `WavelengthUnit`")
+        else:
+            return v
+
+        # validate data type: EnergyUnit
+        if not isinstance(v, EnergyUnit):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `EnergyUnit`")
+        else:
+            return v
+
+        # validate data type: FrequencyUnit
+        if not isinstance(v, FrequencyUnit):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `FrequencyUnit`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in BandpassType with anyOf schemas: EnergyUnit, FrequencyUnit, WavelengthUnit. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        if json_str is None:
+            return instance
+
+        error_messages = []
+        # anyof_schema_1_validator: Optional[WavelengthUnit] = None
+        try:
+            instance.actual_instance = WavelengthUnit.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[EnergyUnit] = None
+        try:
+            instance.actual_instance = EnergyUnit.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[FrequencyUnit] = None
+        try:
+            instance.actual_instance = FrequencyUnit.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into BandpassType with anyOf schemas: EnergyUnit, FrequencyUnit, WavelengthUnit. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], EnergyUnit, FrequencyUnit, WavelengthUnit]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

across/sdk/v1/models/constrained_date.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    ACROSS Server
+
+    Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
+
+    The version of the OpenAPI document: 0.3.2
+    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, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from across.sdk.v1.models.constraint_type import ConstraintType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConstrainedDate(BaseModel):
+    """
+    Represents a constrained date.
+    """ # noqa: E501
+    datetime: datetime
+    constraint: ConstraintType
+    observatory_id: StrictStr
+    __properties: ClassVar[List[str]] = ["datetime", "constraint", "observatory_id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ConstrainedDate from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConstrainedDate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "datetime": obj.get("datetime"),
+            "constraint": obj.get("constraint"),
+            "observatory_id": obj.get("observatory_id")
+        })
+        return _obj
+
+

across/sdk/v1/models/constraint_reason.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    ACROSS Server
+
+    Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
+
+    The version of the OpenAPI document: 0.3.2
+    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, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConstraintReason(BaseModel):
+    """
+    Represents the reasons for constraints.
+    """ # noqa: E501
+    start_reason: StrictStr
+    end_reason: StrictStr
+    __properties: ClassVar[List[str]] = ["start_reason", "end_reason"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ConstraintReason from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConstraintReason from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "start_reason": obj.get("start_reason"),
+            "end_reason": obj.get("end_reason")
+        })
+        return _obj
+
+

across/sdk/v1/models/constraint_type.py

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+"""
+    ACROSS Server
+
+    Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
+
+    The version of the OpenAPI document: 0.3.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ConstraintType(str, Enum):
+    """
+    Represents a constraint.
+    """
+
+    """
+    allowed enum values
+    """
+    SUN_ANGLE = 'Sun Angle'
+    MOON_ANGLE = 'Moon Angle'
+    EARTH_LIMB = 'Earth Limb'
+    WINDOW = 'Window'
+    UNKNOWN = 'Unknown'
+    SOUTH_ATLANTIC_ANOMALY = 'South Atlantic Anomaly'
+    ALTITUDE_SLASH_AZIMUTH_AVOIDANCE = 'Altitude/Azimuth Avoidance'
+    TEST_CONSTRAINT = 'Test Constraint'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ConstraintType from a JSON string"""
+        return cls(json.loads(json_str))
+
+