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

across/sdk/v1/models/validation_error_loc_inner.py

@@ -0,0 +1,138 @@
+# 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, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+VALIDATIONERRORLOCINNER_ANY_OF_SCHEMAS = ["int", "str"]
+
+class ValidationErrorLocInner(BaseModel):
+    """
+    ValidationErrorLocInner
+    """
+
+    # data type: str
+    anyof_schema_1_validator: Optional[StrictStr] = None
+    # data type: int
+    anyof_schema_2_validator: Optional[StrictInt] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[int, str]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "int", "str" }
+
+    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 = ValidationErrorLocInner.model_construct()
+        error_messages = []
+        # validate data type: str
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: int
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ValidationErrorLocInner with anyOf schemas: int, str. 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 = []
+        # deserialize data into str
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into int
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            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 ValidationErrorLocInner with anyOf schemas: int, str. 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], int, str]]:
+        """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/visibility_result.py

@@ -0,0 +1,97 @@
+# 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 across.sdk.v1.models.visibility_window import VisibilityWindow
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VisibilityResult(BaseModel):
+    """
+    A Pydantic model class representing the visibility calculation parameters.  This class is used for visibility calculations in the ACROSS SSA system.
+    """ # noqa: E501
+    instrument_id: StrictStr
+    visibility_windows: List[VisibilityWindow]
+    __properties: ClassVar[List[str]] = ["instrument_id", "visibility_windows"]
+
+    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 VisibilityResult 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in visibility_windows (list)
+        _items = []
+        if self.visibility_windows:
+            for _item_visibility_windows in self.visibility_windows:
+                if _item_visibility_windows:
+                    _items.append(_item_visibility_windows.to_dict())
+            _dict['visibility_windows'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VisibilityResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "instrument_id": obj.get("instrument_id"),
+            "visibility_windows": [VisibilityWindow.from_dict(_item) for _item in obj["visibility_windows"]] if obj.get("visibility_windows") is not None else None
+        })
+        return _obj
+
+

across/sdk/v1/models/visibility_type.py

@@ -0,0 +1,38 @@
+# 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 VisibilityType(str, Enum):
+    """
+    VisibilityType
+    """
+
+    """
+    allowed enum values
+    """
+    EPHEMERIS = 'ephemeris'
+    VO = 'vo'
+    CUSTOM = 'custom'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of VisibilityType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

across/sdk/v1/models/visibility_window.py

@@ -0,0 +1,99 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from across.sdk.v1.models.constraint_reason import ConstraintReason
+from across.sdk.v1.models.window import Window
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VisibilityWindow(BaseModel):
+    """
+    Represents a Visibility Window with max visibility duration and information about the start and end constraints reason.
+    """ # noqa: E501
+    window: Window
+    max_visibility_duration: StrictInt
+    constraint_reason: ConstraintReason
+    __properties: ClassVar[List[str]] = ["window", "max_visibility_duration", "constraint_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 VisibilityWindow 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of window
+        if self.window:
+            _dict['window'] = self.window.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of constraint_reason
+        if self.constraint_reason:
+            _dict['constraint_reason'] = self.constraint_reason.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VisibilityWindow from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "window": Window.from_dict(obj["window"]) if obj.get("window") is not None else None,
+            "max_visibility_duration": obj.get("max_visibility_duration"),
+            "constraint_reason": ConstraintReason.from_dict(obj["constraint_reason"]) if obj.get("constraint_reason") is not None else None
+        })
+        return _obj
+
+

across/sdk/v1/models/wavelength_bandpass.py

@@ -0,0 +1,142 @@
+# 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.wavelength_unit import WavelengthUnit
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WavelengthBandpass(BaseModel):
+    """
+    A class representing a bandpass filter defined in terms of wavelength.  Inherits from `BaseBandpass`, this class specializes the filter to operate in the wavelength domain and provides additional functionality for wavelength-based filters.  Attributes:     type (Literal['WAVELENGTH']): A constant string indicating the type of the bandpass filter.     central_wavelength (float | None): The central wavelength of the filter.     bandwidth (float | None): The bandwidth of the filter.     unit (WavelengthUnit): The unit of measurement for the wavelength.  Methods:     model_post_init(__context: Any) -> None:         Performs validation and calculation of central wavelength and bandwidth based on the min/max range
+    """ # noqa: E501
+    filter_name: Optional[StrictStr] = None
+    min: Optional[Union[StrictFloat, StrictInt]] = None
+    max: Optional[Union[StrictFloat, StrictInt]] = None
+    type: Optional[StrictStr] = 'WAVELENGTH'
+    central_wavelength: Optional[Union[StrictFloat, StrictInt]] = None
+    peak_wavelength: Optional[Union[StrictFloat, StrictInt]] = None
+    bandwidth: Optional[Union[StrictFloat, StrictInt]] = None
+    unit: WavelengthUnit
+    __properties: ClassVar[List[str]] = ["filter_name", "min", "max", "type", "central_wavelength", "peak_wavelength", "bandwidth", "unit"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['WAVELENGTH']):
+            raise ValueError("must be one of enum values ('WAVELENGTH')")
+        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 WavelengthBandpass 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
+
+        # set to None if central_wavelength (nullable) is None
+        # and model_fields_set contains the field
+        if self.central_wavelength is None and "central_wavelength" in self.model_fields_set:
+            _dict['central_wavelength'] = None
+
+        # 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 bandwidth (nullable) is None
+        # and model_fields_set contains the field
+        if self.bandwidth is None and "bandwidth" in self.model_fields_set:
+            _dict['bandwidth'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WavelengthBandpass 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 'WAVELENGTH',
+            "central_wavelength": obj.get("central_wavelength"),
+            "peak_wavelength": obj.get("peak_wavelength"),
+            "bandwidth": obj.get("bandwidth"),
+            "unit": obj.get("unit")
+        })
+        return _obj
+
+

across/sdk/v1/models/wavelength_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 WavelengthUnit(str, Enum):
+    """
+    Enum to represent the bandpass wavelength
+    """
+
+    """
+    allowed enum values
+    """
+    NM = 'nm'
+    ANGSTROM = 'angstrom'
+    UM = 'um'
+    MM = 'mm'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of WavelengthUnit from a JSON string"""
+        return cls(json.loads(json_str))
+
+

across/sdk/v1/models/window.py

@@ -0,0 +1,96 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from across.sdk.v1.models.constrained_date import ConstrainedDate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Window(BaseModel):
+    """
+    Visibility Window
+    """ # noqa: E501
+    begin: ConstrainedDate
+    end: ConstrainedDate
+    __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 Window 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of begin
+        if self.begin:
+            _dict['begin'] = self.begin.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of end
+        if self.end:
+            _dict['end'] = self.end.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Window from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "begin": ConstrainedDate.from_dict(obj["begin"]) if obj.get("begin") is not None else None,
+            "end": ConstrainedDate.from_dict(obj["end"]) if obj.get("end") is not None else None
+        })
+        return _obj
+
+