udl-sdk 0.1.0a1__py3-none-any.whl

unifieddatalibrary/types/port_create_bulk_params.py

@@ -0,0 +1,143 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["PortCreateBulkParams", "Body"]
+
+
+class PortCreateBulkParams(TypedDict, total=False):
+    body: Required[Iterable[Body]]
+
+
+class Body(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.
+    """
+
+    source: Required[str]
+    """Source of the data."""
+
+    id: str
+    """
+    Unique identifier of the record, auto-generated by the system if not provided on
+    create operations.
+    """
+
+    avg_duration: Annotated[float, PropertyInfo(alias="avgDuration")]
+    """Average time for a vessel at this port in hours."""
+
+    country_code: Annotated[str, PropertyInfo(alias="countryCode")]
+    """The country where this port is located."""
+
+    external_id: Annotated[str, PropertyInfo(alias="externalId")]
+    """Optional ID from external systems.
+
+    This field has no meaning within UDL and is provided as a convenience for
+    systems that require tracking of an internal system generated ID.
+    """
+
+    harbor_size: Annotated[float, PropertyInfo(alias="harborSize")]
+    """The size of the harbor for this port measured in square kilometers."""
+
+    harbor_type: Annotated[str, PropertyInfo(alias="harborType")]
+    """The type of harbor for this port.
+
+    The harbor type refers to how a port is physically positioned.
+
+    COASTAL BREAKWATER (CB)
+
+    COASTAL NATURAL (CN)
+
+    COASTAL TIDE GATE (CT)
+
+    LAKE OR CANAL (LC)
+
+    OPEN ROADSTEAD (OR)
+
+    RIVER BASIN (RB)
+
+    RIVER NATURAL (RN)
+
+    RIVER TIDE GATE (RT)
+
+    TYPHOON HARBOR (TH).
+    """
+
+    id_site: Annotated[str, PropertyInfo(alias="idSite")]
+    """Unique identifier of the Site Entity associated with the Port record."""
+
+    lat: float
+    """WGS84 latitude of the location, in degrees.
+
+    -90 to 90 degrees (negative values south of equator).
+    """
+
+    locode: str
+    """
+    The five-character United Nations Code for Trade and Transport Locations
+    (UN/LOCODE) of this port. The first two letters of the code contains the ISO
+    3166-1 alpha-2 country designation of the port country. The three remaining
+    characters identify a location within that country. Letters are preferred, but
+    if necessary digits 2 through 9 may be used, excluding "0" and "1" to avoid
+    confusion with the letters "O" and "I" respectively.
+    """
+
+    lon: float
+    """WGS84 longitude of the location, in degrees.
+
+    -180 to 180 degrees (negative values west of Prime Meridian).
+    """
+
+    max_draught: Annotated[float, PropertyInfo(alias="maxDraught")]
+    """Maximum allowed vessel draught.
+
+    Draught is the principal dimensions of any waterborne vessel defined as the
+    distance between the ship’s keel and the waterline of the vessel measured in
+    meters.
+    """
+
+    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.
+    """
+
+    pilot_reqd: Annotated[bool, PropertyInfo(alias="pilotReqd")]
+    """Flag indicating whether a pilot is required at this port."""
+
+    port_name: Annotated[str, PropertyInfo(alias="portName")]
+    """The name of this port."""
+
+    shelter: str
+    """
+    The shelter afforded from wind, sea, and swell refers to the area where normal
+    port operations are conducted, usually the wharf area. Shelter afforded by the
+    anchorage area may be given for ports where cargo is handled by lighters. Values
+    given are EXCELLENT, FAIR, GOOD, POOR, or NONE.
+    """
+
+    tide_range: Annotated[float, PropertyInfo(alias="tideRange")]
+    """The tide range of this port in meters."""

unifieddatalibrary/types/port_create_params.py

@@ -0,0 +1,138 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["PortCreateParams"]
+
+
+class PortCreateParams(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.
+    """
+
+    source: Required[str]
+    """Source of the data."""
+
+    id: str
+    """
+    Unique identifier of the record, auto-generated by the system if not provided on
+    create operations.
+    """
+
+    avg_duration: Annotated[float, PropertyInfo(alias="avgDuration")]
+    """Average time for a vessel at this port in hours."""
+
+    country_code: Annotated[str, PropertyInfo(alias="countryCode")]
+    """The country where this port is located."""
+
+    external_id: Annotated[str, PropertyInfo(alias="externalId")]
+    """Optional ID from external systems.
+
+    This field has no meaning within UDL and is provided as a convenience for
+    systems that require tracking of an internal system generated ID.
+    """
+
+    harbor_size: Annotated[float, PropertyInfo(alias="harborSize")]
+    """The size of the harbor for this port measured in square kilometers."""
+
+    harbor_type: Annotated[str, PropertyInfo(alias="harborType")]
+    """The type of harbor for this port.
+
+    The harbor type refers to how a port is physically positioned.
+
+    COASTAL BREAKWATER (CB)
+
+    COASTAL NATURAL (CN)
+
+    COASTAL TIDE GATE (CT)
+
+    LAKE OR CANAL (LC)
+
+    OPEN ROADSTEAD (OR)
+
+    RIVER BASIN (RB)
+
+    RIVER NATURAL (RN)
+
+    RIVER TIDE GATE (RT)
+
+    TYPHOON HARBOR (TH).
+    """
+
+    id_site: Annotated[str, PropertyInfo(alias="idSite")]
+    """Unique identifier of the Site Entity associated with the Port record."""
+
+    lat: float
+    """WGS84 latitude of the location, in degrees.
+
+    -90 to 90 degrees (negative values south of equator).
+    """
+
+    locode: str
+    """
+    The five-character United Nations Code for Trade and Transport Locations
+    (UN/LOCODE) of this port. The first two letters of the code contains the ISO
+    3166-1 alpha-2 country designation of the port country. The three remaining
+    characters identify a location within that country. Letters are preferred, but
+    if necessary digits 2 through 9 may be used, excluding "0" and "1" to avoid
+    confusion with the letters "O" and "I" respectively.
+    """
+
+    lon: float
+    """WGS84 longitude of the location, in degrees.
+
+    -180 to 180 degrees (negative values west of Prime Meridian).
+    """
+
+    max_draught: Annotated[float, PropertyInfo(alias="maxDraught")]
+    """Maximum allowed vessel draught.
+
+    Draught is the principal dimensions of any waterborne vessel defined as the
+    distance between the ship’s keel and the waterline of the vessel measured in
+    meters.
+    """
+
+    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.
+    """
+
+    pilot_reqd: Annotated[bool, PropertyInfo(alias="pilotReqd")]
+    """Flag indicating whether a pilot is required at this port."""
+
+    port_name: Annotated[str, PropertyInfo(alias="portName")]
+    """The name of this port."""
+
+    shelter: str
+    """
+    The shelter afforded from wind, sea, and swell refers to the area where normal
+    port operations are conducted, usually the wharf area. Shelter afforded by the
+    anchorage area may be given for ports where cargo is handled by lighters. Values
+    given are EXCELLENT, FAIR, GOOD, POOR, or NONE.
+    """
+
+    tide_range: Annotated[float, PropertyInfo(alias="tideRange")]
+    """The tide range of this port in meters."""

unifieddatalibrary/types/port_get_response.py

@@ -0,0 +1,171 @@
+# 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__ = ["PortGetResponse"]
+
+
+class PortGetResponse(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.
+    """
+
+    source: str
+    """Source of the data."""
+
+    id: Optional[str] = None
+    """
+    Unique identifier of the record, auto-generated by the system if not provided on
+    create operations.
+    """
+
+    avg_duration: Optional[float] = FieldInfo(alias="avgDuration", default=None)
+    """Average time for a vessel at this port in hours."""
+
+    country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
+    """The country where this port is located."""
+
+    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.
+    """
+
+    external_id: Optional[str] = FieldInfo(alias="externalId", default=None)
+    """Optional ID from external systems.
+
+    This field has no meaning within UDL and is provided as a convenience for
+    systems that require tracking of an internal system generated ID.
+    """
+
+    harbor_size: Optional[float] = FieldInfo(alias="harborSize", default=None)
+    """The size of the harbor for this port measured in square kilometers."""
+
+    harbor_type: Optional[str] = FieldInfo(alias="harborType", default=None)
+    """The type of harbor for this port.
+
+    The harbor type refers to how a port is physically positioned.
+
+    COASTAL BREAKWATER (CB)
+
+    COASTAL NATURAL (CN)
+
+    COASTAL TIDE GATE (CT)
+
+    LAKE OR CANAL (LC)
+
+    OPEN ROADSTEAD (OR)
+
+    RIVER BASIN (RB)
+
+    RIVER NATURAL (RN)
+
+    RIVER TIDE GATE (RT)
+
+    TYPHOON HARBOR (TH).
+    """
+
+    id_site: Optional[str] = FieldInfo(alias="idSite", default=None)
+    """Unique identifier of the Site Entity associated with the Port record."""
+
+    lat: Optional[float] = None
+    """WGS84 latitude of the location, in degrees.
+
+    -90 to 90 degrees (negative values south of equator).
+    """
+
+    locode: Optional[str] = None
+    """
+    The five-character United Nations Code for Trade and Transport Locations
+    (UN/LOCODE) of this port. The first two letters of the code contains the ISO
+    3166-1 alpha-2 country designation of the port country. The three remaining
+    characters identify a location within that country. Letters are preferred, but
+    if necessary digits 2 through 9 may be used, excluding "0" and "1" to avoid
+    confusion with the letters "O" and "I" respectively.
+    """
+
+    lon: Optional[float] = None
+    """WGS84 longitude of the location, in degrees.
+
+    -180 to 180 degrees (negative values west of Prime Meridian).
+    """
+
+    max_draught: Optional[float] = FieldInfo(alias="maxDraught", default=None)
+    """Maximum allowed vessel draught.
+
+    Draught is the principal dimensions of any waterborne vessel defined as the
+    distance between the ship’s keel and the waterline of the vessel measured in
+    meters.
+    """
+
+    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.
+    """
+
+    pilot_reqd: Optional[bool] = FieldInfo(alias="pilotReqd", default=None)
+    """Flag indicating whether a pilot is required at this port."""
+
+    port_name: Optional[str] = FieldInfo(alias="portName", default=None)
+    """The name of this port."""
+
+    shelter: Optional[str] = None
+    """
+    The shelter afforded from wind, sea, and swell refers to the area where normal
+    port operations are conducted, usually the wharf area. Shelter afforded by the
+    anchorage area may be given for ports where cargo is handled by lighters. Values
+    given are EXCELLENT, FAIR, GOOD, POOR, or NONE.
+    """
+
+    source_dl: Optional[str] = FieldInfo(alias="sourceDL", default=None)
+    """The source data library from which this record was received.
+
+    This could be a remote or tactical UDL or another data library. If null, the
+    record should be assumed to have originated from the primary Enterprise UDL.
+    """
+
+    tide_range: Optional[float] = FieldInfo(alias="tideRange", default=None)
+    """The tide range of this port in meters."""
+
+    updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
+    """Time the row was updated in the database, auto-populated by the system."""
+
+    updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
+    """
+    Application user who updated the row in the database, auto-populated by the
+    system.
+    """

unifieddatalibrary/types/port_list_response.py

@@ -0,0 +1,158 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["PortListResponse", "PortListResponseItem"]
+
+
+class PortListResponseItem(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.
+    """
+
+    source: str
+    """Source of the data."""
+
+    id: Optional[str] = None
+    """
+    Unique identifier of the record, auto-generated by the system if not provided on
+    create operations.
+    """
+
+    avg_duration: Optional[float] = FieldInfo(alias="avgDuration", default=None)
+    """Average time for a vessel at this port in hours."""
+
+    country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
+    """The country where this port is located."""
+
+    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.
+    """
+
+    external_id: Optional[str] = FieldInfo(alias="externalId", default=None)
+    """Optional ID from external systems.
+
+    This field has no meaning within UDL and is provided as a convenience for
+    systems that require tracking of an internal system generated ID.
+    """
+
+    harbor_size: Optional[float] = FieldInfo(alias="harborSize", default=None)
+    """The size of the harbor for this port measured in square kilometers."""
+
+    harbor_type: Optional[str] = FieldInfo(alias="harborType", default=None)
+    """The type of harbor for this port.
+
+    The harbor type refers to how a port is physically positioned.
+
+    COASTAL BREAKWATER (CB)
+
+    COASTAL NATURAL (CN)
+
+    COASTAL TIDE GATE (CT)
+
+    LAKE OR CANAL (LC)
+
+    OPEN ROADSTEAD (OR)
+
+    RIVER BASIN (RB)
+
+    RIVER NATURAL (RN)
+
+    RIVER TIDE GATE (RT)
+
+    TYPHOON HARBOR (TH).
+    """
+
+    id_site: Optional[str] = FieldInfo(alias="idSite", default=None)
+    """Unique identifier of the Site Entity associated with the Port record."""
+
+    lat: Optional[float] = None
+    """WGS84 latitude of the location, in degrees.
+
+    -90 to 90 degrees (negative values south of equator).
+    """
+
+    locode: Optional[str] = None
+    """
+    The five-character United Nations Code for Trade and Transport Locations
+    (UN/LOCODE) of this port. The first two letters of the code contains the ISO
+    3166-1 alpha-2 country designation of the port country. The three remaining
+    characters identify a location within that country. Letters are preferred, but
+    if necessary digits 2 through 9 may be used, excluding "0" and "1" to avoid
+    confusion with the letters "O" and "I" respectively.
+    """
+
+    lon: Optional[float] = None
+    """WGS84 longitude of the location, in degrees.
+
+    -180 to 180 degrees (negative values west of Prime Meridian).
+    """
+
+    max_draught: Optional[float] = FieldInfo(alias="maxDraught", default=None)
+    """Maximum allowed vessel draught.
+
+    Draught is the principal dimensions of any waterborne vessel defined as the
+    distance between the ship’s keel and the waterline of the vessel measured in
+    meters.
+    """
+
+    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.
+    """
+
+    pilot_reqd: Optional[bool] = FieldInfo(alias="pilotReqd", default=None)
+    """Flag indicating whether a pilot is required at this port."""
+
+    port_name: Optional[str] = FieldInfo(alias="portName", default=None)
+    """The name of this port."""
+
+    shelter: Optional[str] = None
+    """
+    The shelter afforded from wind, sea, and swell refers to the area where normal
+    port operations are conducted, usually the wharf area. Shelter afforded by the
+    anchorage area may be given for ports where cargo is handled by lighters. Values
+    given are EXCELLENT, FAIR, GOOD, POOR, or NONE.
+    """
+
+    tide_range: Optional[float] = FieldInfo(alias="tideRange", default=None)
+    """The tide range of this port in meters."""
+
+
+PortListResponse: TypeAlias = List[PortListResponseItem]

unifieddatalibrary/types/port_tuple_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["PortTupleParams"]
+
+
+class PortTupleParams(TypedDict, total=False):
+    columns: Required[str]
+    """
+    Comma-separated list of valid field names for this data type to be returned in
+    the response. Only the fields specified will be returned as well as the
+    classification marking of the data, if applicable. See the ‘queryhelp’ operation
+    for a complete list of possible fields.
+    """