udl-sdk 0.1.0a17__py3-none-any.whl → 0.1.0a18__py3-none-any.whl

unifieddatalibrary/types/onorbitsolararray_update_params.py

@@ -5,8 +5,9 @@ from __future__ import annotations
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
+from .shared_params.solar_array_ingest import SolarArrayIngest
 
-__all__ = ["OnorbitsolararrayUpdateParams", "SolarArray"]
+__all__ = ["OnorbitsolararrayUpdateParams"]
 
 
 class OnorbitsolararrayUpdateParams(TypedDict, total=False):
@@ -56,45 +57,9 @@ class OnorbitsolararrayUpdateParams(TypedDict, total=False):
     idSolarArray.
     """
 
-    solar_array: Annotated[SolarArray, PropertyInfo(alias="solarArray")]
+    solar_array: Annotated[SolarArrayIngest, PropertyInfo(alias="solarArray")]
     """Model representation of information on on-orbit/spacecraft solar arrays.
 
     A spacecraft may have multiple solar arrays and each solar array can have
     multiple 'details' records compiled by different sources.
     """
-
-
-class SolarArray(TypedDict, total=False):
-    data_mode: Required[Annotated[Literal["REAL", "TEST", "SIMULATED", "EXERCISE"], PropertyInfo(alias="dataMode")]]
-    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
-
-    EXERCISE: Data pertaining to a government or military exercise. The data
-    may include both real and simulated data.
-
-    REAL: Data collected or produced that pertains to real-world objects,
-    events, and analysis.
-
-    SIMULATED: Synthetic data generated by a model to mimic real-world
-    datasets.
-
-    TEST: Specific datasets used to evaluate compliance with specifications and
-    requirements, and for validating technical, functional, and performance
-    characteristics.
-    """
-
-    name: Required[str]
-    """Solar Array name."""
-
-    source: Required[str]
-    """Source of the data."""
-
-    id: str
-    """Unique identifier of the record, auto-generated by the system."""
-
-    origin: str
-    """
-    Originating system or organization which produced the data, if different from
-    the source. The origin may be different than the source if the source was a
-    mediating system which forwarded the data on behalf of the origin system. If
-    null, the source may be assumed to be the origin.
-    """

unifieddatalibrary/types/onorbitthruster_create_params.py

@@ -5,8 +5,9 @@ from __future__ import annotations
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
+from .shared_params.engine_ingest import EngineIngest
 
-__all__ = ["OnorbitthrusterCreateParams", "Engine"]
+__all__ = ["OnorbitthrusterCreateParams"]
 
 
 class OnorbitthrusterCreateParams(TypedDict, total=False):
@@ -42,7 +43,7 @@ class OnorbitthrusterCreateParams(TypedDict, total=False):
     id: str
     """Unique identifier of the record, auto-generated by the system."""
 
-    engine: Engine
+    engine: EngineIngest
     """Known launch vehicle engines and their performance characteristics and limits.
 
     A launch vehicle has 1 to many engines per stage.
@@ -67,42 +68,3 @@ class OnorbitthrusterCreateParams(TypedDict, total=False):
 
     LAE, Hydrazine REA, etc.).
     """
-
-
-class Engine(TypedDict, total=False):
-    classification_marking: Required[Annotated[str, PropertyInfo(alias="classificationMarking")]]
-    """Classification marking of the data in IC/CAPCO Portion-marked format."""
-
-    data_mode: Required[Annotated[Literal["REAL", "TEST", "SIMULATED", "EXERCISE"], PropertyInfo(alias="dataMode")]]
-    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
-
-    EXERCISE: Data pertaining to a government or military exercise. The data
-    may include both real and simulated data.
-
-    REAL: Data collected or produced that pertains to real-world objects,
-    events, and analysis.
-
-    SIMULATED: Synthetic data generated by a model to mimic real-world
-    datasets.
-
-    TEST: Specific datasets used to evaluate compliance with specifications and
-    requirements, and for validating technical, functional, and performance
-    characteristics.
-    """
-
-    name: Required[str]
-    """Engine name/variant."""
-
-    source: Required[str]
-    """Source of the data."""
-
-    id: str
-    """Unique identifier of the record, auto-generated by the system."""
-
-    origin: str
-    """
-    Originating system or organization which produced the data, if different from
-    the source. The origin may be different than the source if the source was a
-    mediating system which forwarded the data on behalf of the origin system. If
-    null, the source may be assumed to be the origin.
-    """

unifieddatalibrary/types/onorbitthruster_update_params.py

@@ -5,8 +5,9 @@ from __future__ import annotations
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
+from .shared_params.engine_ingest import EngineIngest
 
-__all__ = ["OnorbitthrusterUpdateParams", "Engine"]
+__all__ = ["OnorbitthrusterUpdateParams"]
 
 
 class OnorbitthrusterUpdateParams(TypedDict, total=False):
@@ -42,7 +43,7 @@ class OnorbitthrusterUpdateParams(TypedDict, total=False):
     body_id: Annotated[str, PropertyInfo(alias="id")]
     """Unique identifier of the record, auto-generated by the system."""
 
-    engine: Engine
+    engine: EngineIngest
     """Known launch vehicle engines and their performance characteristics and limits.
 
     A launch vehicle has 1 to many engines per stage.
@@ -67,42 +68,3 @@ class OnorbitthrusterUpdateParams(TypedDict, total=False):
 
     LAE, Hydrazine REA, etc.).
     """
-
-
-class Engine(TypedDict, total=False):
-    classification_marking: Required[Annotated[str, PropertyInfo(alias="classificationMarking")]]
-    """Classification marking of the data in IC/CAPCO Portion-marked format."""
-
-    data_mode: Required[Annotated[Literal["REAL", "TEST", "SIMULATED", "EXERCISE"], PropertyInfo(alias="dataMode")]]
-    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
-
-    EXERCISE: Data pertaining to a government or military exercise. The data
-    may include both real and simulated data.
-
-    REAL: Data collected or produced that pertains to real-world objects,
-    events, and analysis.
-
-    SIMULATED: Synthetic data generated by a model to mimic real-world
-    datasets.
-
-    TEST: Specific datasets used to evaluate compliance with specifications and
-    requirements, and for validating technical, functional, and performance
-    characteristics.
-    """
-
-    name: Required[str]
-    """Engine name/variant."""
-
-    source: Required[str]
-    """Source of the data."""
-
-    id: str
-    """Unique identifier of the record, auto-generated by the system."""
-
-    origin: str
-    """
-    Originating system or organization which produced the data, if different from
-    the source. The origin may be different than the source if the source was a
-    mediating system which forwarded the data on behalf of the origin system. If
-    null, the source may be assumed to be the origin.
-    """

unifieddatalibrary/types/point_of_contact_ingest_param.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["PointOfContactIngestParam"]
+
+
+class PointOfContactIngestParam(TypedDict, total=False):
+    office: str
+    """Office name for which the contact belongs."""
+
+    phone: str
+    """Phone number of the contact."""
+
+    poc_name: Annotated[str, PropertyInfo(alias="pocName")]
+    """The name of the contact."""
+
+    poc_org: Annotated[str, PropertyInfo(alias="pocOrg")]
+    """Organization name for which the contact belongs."""
+
+    poc_sequence_id: Annotated[int, PropertyInfo(alias="pocSequenceId")]
+    """Sequencing field for point of contact."""
+
+    poc_type_name: Annotated[str, PropertyInfo(alias="pocTypeName")]
+    """
+    A code or name that represents the contact's role in association to the track
+    route (ex. Originator, Scheduler, Maintainer, etc.).
+    """
+
+    rank: str
+    """The rank of contact."""
+
+    remark: str
+    """Text of the remark."""
+
+    username: str
+    """The username of the contact."""

unifieddatalibrary/types/route_points_ingest_param.py

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["RoutePointsIngestParam"]
+
+
+class RoutePointsIngestParam(TypedDict, total=False):
+    alt_country_code: Annotated[str, PropertyInfo(alias="altCountryCode")]
+    """
+    Specifies an alternate country code if the data provider code is not part of an
+    official NAVAID Country Code standard such as ISO-3166 or FIPS. This field will
+    be set to the value provided by the source and should be used for all Queries
+    specifying a Country Code.
+    """
+
+    country_code: Annotated[str, PropertyInfo(alias="countryCode")]
+    """
+    The DoD Standard Country Code designator for the country where the route point
+    resides. This field should be set to "OTHR" if the source value does not match a
+    UDL country code value (ISO-3166-ALPHA-2).
+    """
+
+    dafif_pt: Annotated[bool, PropertyInfo(alias="dafifPt")]
+    """
+    Flag indicating this is a Digital Aeronautical Flight Information File (DAFIF)
+    point.
+    """
+
+    mag_dec: Annotated[float, PropertyInfo(alias="magDec")]
+    """
+    The magnetic declination/variation of the route point location from true north,
+    in degrees. Positive values east of true north and negative values west of true
+    north.
+    """
+
+    navaid: str
+    """Navigational Aid (NAVAID) identification code."""
+
+    navaid_length: Annotated[float, PropertyInfo(alias="navaidLength")]
+    """The length of the course from the Navigational Aid (NAVAID) in nautical miles."""
+
+    navaid_type: Annotated[str, PropertyInfo(alias="navaidType")]
+    """The NAVAID type of this route point (ex. VOR, VORTAC, TACAN, etc.)."""
+
+    pt_lat: Annotated[float, PropertyInfo(alias="ptLat")]
+    """WGS84 latitude of the point location, in degrees.
+
+    -90 to 90 degrees (negative values south of equator).
+    """
+
+    pt_lon: Annotated[float, PropertyInfo(alias="ptLon")]
+    """WGS84 longitude of the point location, in degrees.
+
+    -180 to 180 degrees (negative values west of Prime Meridian).
+    """
+
+    pt_sequence_id: Annotated[int, PropertyInfo(alias="ptSequenceId")]
+    """Sequencing field for the track route.
+
+    This is the identifier representing the sequence of waypoints associated to the
+    track route.
+    """
+
+    pt_type_code: Annotated[str, PropertyInfo(alias="ptTypeCode")]
+    """Code representation of the point within the track route (ex.
+
+    EP, EX, CP, IP, etc.).
+    """
+
+    pt_type_name: Annotated[str, PropertyInfo(alias="ptTypeName")]
+    """The name that represents the point within the track route (ex.
+
+    ENTRY POINT, EXIT POINT, CONTROL POINT, INITIAL POINT, etc.).
+    """
+
+    waypoint_name: Annotated[str, PropertyInfo(alias="waypointName")]
+    """Name of a waypoint which identifies the location of the point."""

unifieddatalibrary/types/shared/__init__.py

@@ -21,7 +21,10 @@ from .pathway_full import PathwayFull as PathwayFull
 from .rf_band_full import RfBandFull as RfBandFull
 from .aircraft_full import AircraftFull as AircraftFull
 from .airfield_full import AirfieldFull as AirfieldFull
+from .engine_ingest import EngineIngest as EngineIngest
 from .location_full import LocationFull as LocationFull
+from .antenna_ingest import AntennaIngest as AntennaIngest
+from .battery_ingest import BatteryIngest as BatteryIngest
 from .ephemeris_full import EphemerisFull as EphemerisFull
 from .sortie_ppr_full import SortiePprFull as SortiePprFull
 from .sub_status_full import SubStatusFull as SubStatusFull
@@ -38,8 +41,10 @@ from .location_abridged import LocationAbridged as LocationAbridged
 from .notification_full import NotificationFull as NotificationFull
 from .organization_full import OrganizationFull as OrganizationFull
 from .state_vector_full import StateVectorFull as StateVectorFull
+from .sub_status_ingest import SubStatusIngest as SubStatusIngest
 from .drift_history_full import DriftHistoryFull as DriftHistoryFull
 from .operatingunit_full import OperatingunitFull as OperatingunitFull
+from .solar_array_ingest import SolarArrayIngest as SolarArrayIngest
 from .aircraftsortie_full import AircraftsortieFull as AircraftsortieFull
 from .aircraftstatus_full import AircraftstatusFull as AircraftstatusFull
 from .airfieldstatus_full import AirfieldstatusFull as AirfieldstatusFull

unifieddatalibrary/types/shared/antenna_ingest.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["AntennaIngest"]
+
+
+class AntennaIngest(BaseModel):
+    data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
+    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+    EXERCISE: Data pertaining to a government or military exercise. The data
+    may include both real and simulated data.
+
+    REAL: Data collected or produced that pertains to real-world objects,
+    events, and analysis.
+
+    SIMULATED: Synthetic data generated by a model to mimic real-world
+    datasets.
+
+    TEST: Specific datasets used to evaluate compliance with specifications and
+    requirements, and for validating technical, functional, and performance
+    characteristics.
+    """
+
+    name: str
+    """Antenna name."""
+
+    source: str
+    """Source of the data."""
+
+    id: Optional[str] = None
+    """Unique identifier of the record, auto-generated by the system."""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """Time the row was created in the database, auto-populated by the system."""
+
+    created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
+    """
+    Application user who created the row in the database, auto-populated by the
+    system.
+    """
+
+    origin: Optional[str] = None
+    """
+    Originating system or organization which produced the data, if different from
+    the source. The origin may be different than the source if the source was a
+    mediating system which forwarded the data on behalf of the origin system. If
+    null, the source may be assumed to be the origin.
+    """
+
+    orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
+    """
+    The originating source network on which this record was created, auto-populated
+    by the system.
+    """

unifieddatalibrary/types/shared/battery_ingest.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["BatteryIngest"]
+
+
+class BatteryIngest(BaseModel):
+    data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
+    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+    EXERCISE: Data pertaining to a government or military exercise. The data
+    may include both real and simulated data.
+
+    REAL: Data collected or produced that pertains to real-world objects,
+    events, and analysis.
+
+    SIMULATED: Synthetic data generated by a model to mimic real-world
+    datasets.
+
+    TEST: Specific datasets used to evaluate compliance with specifications and
+    requirements, and for validating technical, functional, and performance
+    characteristics.
+    """
+
+    name: str
+    """Battery name."""
+
+    source: str
+    """Source of the data."""
+
+    id: Optional[str] = None
+    """Unique identifier of the record, auto-generated by the system."""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """Time the row was created in the database, auto-populated by the system."""
+
+    created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
+    """
+    Application user who created the row in the database, auto-populated by the
+    system.
+    """
+
+    origin: Optional[str] = None
+    """
+    Originating system or organization which produced the data, if different from
+    the source. The origin may be different than the source if the source was a
+    mediating system which forwarded the data on behalf of the origin system. If
+    null, the source may be assumed to be the origin.
+    """
+
+    orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
+    """
+    The originating source network on which this record was created, auto-populated
+    by the system.
+    """

unifieddatalibrary/types/shared/engine_ingest.py

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["EngineIngest"]
+
+
+class EngineIngest(BaseModel):
+    classification_marking: str = FieldInfo(alias="classificationMarking")
+    """Classification marking of the data in IC/CAPCO Portion-marked format."""
+
+    data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
+    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+    EXERCISE: Data pertaining to a government or military exercise. The data
+    may include both real and simulated data.
+
+    REAL: Data collected or produced that pertains to real-world objects,
+    events, and analysis.
+
+    SIMULATED: Synthetic data generated by a model to mimic real-world
+    datasets.
+
+    TEST: Specific datasets used to evaluate compliance with specifications and
+    requirements, and for validating technical, functional, and performance
+    characteristics.
+    """
+
+    name: str
+    """Engine name/variant."""
+
+    source: str
+    """Source of the data."""
+
+    id: Optional[str] = None
+    """Unique identifier of the record, auto-generated by the system."""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """Time the row was created in the database, auto-populated by the system."""
+
+    created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
+    """
+    Application user who created the row in the database, auto-populated by the
+    system.
+    """
+
+    origin: Optional[str] = None
+    """
+    Originating system or organization which produced the data, if different from
+    the source. The origin may be different than the source if the source was a
+    mediating system which forwarded the data on behalf of the origin system. If
+    null, the source may be assumed to be the origin.
+    """
+
+    orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
+    """
+    The originating source network on which this record was created, auto-populated
+    by the system.
+    """

unifieddatalibrary/types/shared/solar_array_ingest.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["SolarArrayIngest"]
+
+
+class SolarArrayIngest(BaseModel):
+    data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
+    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+    EXERCISE: Data pertaining to a government or military exercise. The data
+    may include both real and simulated data.
+
+    REAL: Data collected or produced that pertains to real-world objects,
+    events, and analysis.
+
+    SIMULATED: Synthetic data generated by a model to mimic real-world
+    datasets.
+
+    TEST: Specific datasets used to evaluate compliance with specifications and
+    requirements, and for validating technical, functional, and performance
+    characteristics.
+    """
+
+    name: str
+    """Solar Array name."""
+
+    source: str
+    """Source of the data."""
+
+    id: Optional[str] = None
+    """Unique identifier of the record, auto-generated by the system."""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """Time the row was created in the database, auto-populated by the system."""
+
+    created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
+    """
+    Application user who created the row in the database, auto-populated by the
+    system.
+    """
+
+    origin: Optional[str] = None
+    """
+    Originating system or organization which produced the data, if different from
+    the source. The origin may be different than the source if the source was a
+    mediating system which forwarded the data on behalf of the origin system. If
+    null, the source may be assumed to be the origin.
+    """
+
+    orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
+    """
+    The originating source network on which this record was created, auto-populated
+    by the system.
+    """

unifieddatalibrary/types/shared/sub_status_ingest.py

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["SubStatusIngest"]
+
+
+class SubStatusIngest(BaseModel):
+    classification_marking: str = FieldInfo(alias="classificationMarking")
+    """Classification marking of the data in IC/CAPCO Portion-marked format."""
+
+    data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
+    """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+    EXERCISE: Data pertaining to a government or military exercise. The data
+    may include both real and simulated data.
+
+    REAL: Data collected or produced that pertains to real-world objects,
+    events, and analysis.
+
+    SIMULATED: Synthetic data generated by a model to mimic real-world
+    datasets.
+
+    TEST: Specific datasets used to evaluate compliance with specifications and
+    requirements, and for validating technical, functional, and performance
+    characteristics.
+    """
+
+    notes: str
+    """Descriptions and/or comments associated with the sub-status."""
+
+    source: str
+    """Source of the data."""
+
+    status: Literal["FMC", "NMC", "PMC", "UNK"]
+    """Status of the sub-system/capability, e.g. FMC, NMC, PMC, UNK."""
+
+    status_id: str = FieldInfo(alias="statusId")
+    """Id of the parent status."""
+
+    type: Literal["mwCap", "ssCap", "mdCap"]
+    """Parent entity's sub-system or capability status: mwCap, mdCap, ssCap, etc."""
+
+    id: Optional[str] = None
+    """Unique identifier of the record, auto-generated by the system."""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """Time the row was created in the database, auto-populated by the system."""
+
+    created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
+    """
+    Application user who created the row in the database, auto-populated by the
+    system.
+    """
+
+    origin: Optional[str] = None
+    """
+    Originating system or organization which produced the data, if different from
+    the source. The origin may be different than the source if the source was a
+    mediating system which forwarded the data on behalf of the origin system. If
+    null, the source may be assumed to be the origin.
+    """
+
+    orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
+    """
+    The originating source network on which this record was created, auto-populated
+    by the system.
+    """

unifieddatalibrary/types/shared_params/__init__.py

@@ -1,3 +1,8 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from .file_data import FileData as FileData
+from .engine_ingest import EngineIngest as EngineIngest
+from .antenna_ingest import AntennaIngest as AntennaIngest
+from .battery_ingest import BatteryIngest as BatteryIngest
+from .sub_status_ingest import SubStatusIngest as SubStatusIngest
+from .solar_array_ingest import SolarArrayIngest as SolarArrayIngest