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

across/sdk/v1/models/coordinate.py

@@ -0,0 +1,100 @@
+# 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
+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 Coordinate(BaseModel):
+    """
+    Coordinate
+    """ # noqa: E501
+    ra: Optional[Union[Annotated[float, Field(le=360.0, strict=True, ge=0.0)], Annotated[int, Field(le=360, strict=True, ge=0)]]]
+    dec: Optional[Union[Annotated[float, Field(le=90.0, strict=True, ge=-90.0)], Annotated[int, Field(le=90, strict=True, ge=-90)]]]
+    __properties: ClassVar[List[str]] = ["ra", "dec"]
+
+    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 Coordinate 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 ra (nullable) is None
+        # and model_fields_set contains the field
+        if self.ra is None and "ra" in self.model_fields_set:
+            _dict['ra'] = None
+
+        # set to None if dec (nullable) is None
+        # and model_fields_set contains the field
+        if self.dec is None and "dec" in self.model_fields_set:
+            _dict['dec'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Coordinate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ra": obj.get("ra"),
+            "dec": obj.get("dec")
+        })
+        return _obj
+
+

across/sdk/v1/models/date_range.py

@@ -0,0 +1,90 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DateRange(BaseModel):
+    """
+    DateRange
+    """ # noqa: E501
+    begin: datetime
+    end: datetime
+    __properties: ClassVar[List[str]] = ["begin", "end"]
+
+    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 DateRange 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 DateRange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "begin": obj.get("begin"),
+            "end": obj.get("end")
+        })
+        return _obj
+
+

across/sdk/v1/models/depth_unit.py

@@ -0,0 +1,39 @@
+# 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 DepthUnit(str, Enum):
+    """
+    DepthUnit
+    """
+
+    """
+    allowed enum values
+    """
+    AB_MAG = 'ab_mag'
+    VEGA_MAG = 'vega_mag'
+    FLUX_ERG = 'flux_erg'
+    FLUX_JY = 'flux_jy'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DepthUnit from a JSON string"""
+        return cls(json.loads(json_str))
+
+

across/sdk/v1/models/earth_limb_constraint.py

@@ -0,0 +1,124 @@
+# 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, 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 EarthLimbConstraint(BaseModel):
+    """
+    For a given Earth limb avoidance angle, is a given coordinate inside this constraint?  Parameters ---------- name     The name of the constraint. short_name     The short name of the constraint. min_angle     The minimum angle from the Earth limb that the spacecraft can point.  Methods ------- __call__(coord, ephemeris, earth_radius_angle=None)     Checks if a given coordinate is inside the constraint.
+    """ # noqa: E501
+    short_name: Optional[StrictStr] = 'Earth'
+    name: Optional[StrictStr] = 'Earth Limb'
+    min_angle: Optional[Union[Annotated[float, Field(le=180.0, strict=True, ge=0.0)], Annotated[int, Field(le=180, strict=True, ge=0)]]] = None
+    max_angle: Optional[Union[Annotated[float, Field(le=180.0, strict=True, ge=0.0)], Annotated[int, Field(le=180, strict=True, ge=0)]]] = None
+    __properties: ClassVar[List[str]] = ["short_name", "name", "min_angle", "max_angle"]
+
+    @field_validator('short_name')
+    def short_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Earth']):
+            raise ValueError("must be one of enum values ('Earth')")
+        return value
+
+    @field_validator('name')
+    def name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Earth Limb']):
+            raise ValueError("must be one of enum values ('Earth Limb')")
+        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 EarthLimbConstraint 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 min_angle (nullable) is None
+        # and model_fields_set contains the field
+        if self.min_angle is None and "min_angle" in self.model_fields_set:
+            _dict['min_angle'] = None
+
+        # set to None if max_angle (nullable) is None
+        # and model_fields_set contains the field
+        if self.max_angle is None and "max_angle" in self.model_fields_set:
+            _dict['max_angle'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EarthLimbConstraint 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 'Earth',
+            "name": obj.get("name") if obj.get("name") is not None else 'Earth Limb',
+            "min_angle": obj.get("min_angle"),
+            "max_angle": obj.get("max_angle")
+        })
+        return _obj
+
+

across/sdk/v1/models/energy_bandpass.py

@@ -0,0 +1,121 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from across.sdk.v1.models.energy_unit import EnergyUnit
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EnergyBandpass(BaseModel):
+    """
+    A class representing a bandpass filter defined in terms of energy.  Inherits from `BaseBandpass`, this class specializes the filter to operate in the energy domain.  Attributes:     type (Literal['ENERGY']): A constant string indicating the type of the bandpass filter.     unit (EnergyUnit): The unit of measurement for the energy.  Methods:     model_post_init(__context: Any) -> None:         Ensures the min and max energy values are positive and valid.
+    """ # noqa: E501
+    filter_name: Optional[StrictStr] = None
+    min: Optional[Union[StrictFloat, StrictInt]] = None
+    max: Optional[Union[StrictFloat, StrictInt]] = None
+    type: Optional[StrictStr] = 'ENERGY'
+    unit: EnergyUnit
+    __properties: ClassVar[List[str]] = ["filter_name", "min", "max", "type", "unit"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ENERGY']):
+            raise ValueError("must be one of enum values ('ENERGY')")
+        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 EnergyBandpass 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 filter_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.filter_name is None and "filter_name" in self.model_fields_set:
+            _dict['filter_name'] = None
+
+        # set to None if min (nullable) is None
+        # and model_fields_set contains the field
+        if self.min is None and "min" in self.model_fields_set:
+            _dict['min'] = None
+
+        # set to None if max (nullable) is None
+        # and model_fields_set contains the field
+        if self.max is None and "max" in self.model_fields_set:
+            _dict['max'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EnergyBandpass from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "filter_name": obj.get("filter_name"),
+            "min": obj.get("min"),
+            "max": obj.get("max"),
+            "type": obj.get("type") if obj.get("type") is not None else 'ENERGY',
+            "unit": obj.get("unit")
+        })
+        return _obj
+
+

across/sdk/v1/models/energy_unit.py

@@ -0,0 +1,40 @@
+# 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 EnergyUnit(str, Enum):
+    """
+    Enum to represent the bandpass energy types
+    """
+
+    """
+    allowed enum values
+    """
+    EV = 'eV'
+    KEV = 'keV'
+    MEV = 'MeV'
+    GEV = 'GeV'
+    TEV = 'TeV'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EnergyUnit from a JSON string"""
+        return cls(json.loads(json_str))
+
+

across/sdk/v1/models/ephemeris_type.py

@@ -0,0 +1,39 @@
+# 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 EphemerisType(str, Enum):
+    """
+    EphemerisType
+    """
+
+    """
+    allowed enum values
+    """
+    TLE = 'tle'
+    SPICE = 'spice'
+    JPL = 'jpl'
+    GROUND = 'ground'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EphemerisType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

across/sdk/v1/models/filter.py

@@ -0,0 +1,135 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Filter(BaseModel):
+    """
+    A Pydantic model class representing a created Filter  Notes ----- Inherits from FilterBase
+    """ # noqa: E501
+    id: StrictStr
+    created_on: datetime
+    name: StrictStr
+    peak_wavelength: Optional[Union[StrictFloat, StrictInt]]
+    min_wavelength: Union[StrictFloat, StrictInt]
+    max_wavelength: Union[StrictFloat, StrictInt]
+    is_operational: StrictBool
+    sensitivity_depth_unit: Optional[Union[StrictFloat, StrictInt]]
+    sensitivity_depth: Optional[Union[StrictFloat, StrictInt]]
+    sensitivity_time_seconds: Optional[Union[StrictFloat, StrictInt]]
+    reference_url: Optional[StrictStr]
+    instrument_id: StrictStr
+    __properties: ClassVar[List[str]] = ["id", "created_on", "name", "peak_wavelength", "min_wavelength", "max_wavelength", "is_operational", "sensitivity_depth_unit", "sensitivity_depth", "sensitivity_time_seconds", "reference_url", "instrument_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 Filter 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 peak_wavelength (nullable) is None
+        # and model_fields_set contains the field
+        if self.peak_wavelength is None and "peak_wavelength" in self.model_fields_set:
+            _dict['peak_wavelength'] = None
+
+        # set to None if sensitivity_depth_unit (nullable) is None
+        # and model_fields_set contains the field
+        if self.sensitivity_depth_unit is None and "sensitivity_depth_unit" in self.model_fields_set:
+            _dict['sensitivity_depth_unit'] = None
+
+        # set to None if sensitivity_depth (nullable) is None
+        # and model_fields_set contains the field
+        if self.sensitivity_depth is None and "sensitivity_depth" in self.model_fields_set:
+            _dict['sensitivity_depth'] = None
+
+        # set to None if sensitivity_time_seconds (nullable) is None
+        # and model_fields_set contains the field
+        if self.sensitivity_time_seconds is None and "sensitivity_time_seconds" in self.model_fields_set:
+            _dict['sensitivity_time_seconds'] = None
+
+        # set to None if reference_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.reference_url is None and "reference_url" in self.model_fields_set:
+            _dict['reference_url'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Filter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "created_on": obj.get("created_on"),
+            "name": obj.get("name"),
+            "peak_wavelength": obj.get("peak_wavelength"),
+            "min_wavelength": obj.get("min_wavelength"),
+            "max_wavelength": obj.get("max_wavelength"),
+            "is_operational": obj.get("is_operational"),
+            "sensitivity_depth_unit": obj.get("sensitivity_depth_unit"),
+            "sensitivity_depth": obj.get("sensitivity_depth"),
+            "sensitivity_time_seconds": obj.get("sensitivity_time_seconds"),
+            "reference_url": obj.get("reference_url"),
+            "instrument_id": obj.get("instrument_id")
+        })
+        return _obj
+
+