udl-sdk 0.1.0a1__py3-none-any.whl

unifieddatalibrary/resources/beam_contours.py

@@ -0,0 +1,1314 @@
+# 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
+
+import httpx
+
+from ..types import (
+    beam_contour_list_params,
+    beam_contour_count_params,
+    beam_contour_tuple_params,
+    beam_contour_create_params,
+    beam_contour_update_params,
+    beam_contour_create_bulk_params,
+)
+from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from .._utils import (
+    maybe_transform,
+    async_maybe_transform,
+)
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from .._base_client import make_request_options
+from ..types.beamcontour_full import BeamcontourFull
+from ..types.beam_contour_list_response import BeamContourListResponse
+from ..types.beam_contour_tuple_response import BeamContourTupleResponse
+
+__all__ = ["BeamContoursResource", "AsyncBeamContoursResource"]
+
+
+class BeamContoursResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> BeamContoursResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/rsivilli-bluestaq/udl-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return BeamContoursResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> BeamContoursResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/rsivilli-bluestaq/udl-python-sdk#with_streaming_response
+        """
+        return BeamContoursResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        id_beam: str,
+        source: str,
+        type: Literal["BORESIGHT", "CONTOUR", "SVC AREA"],
+        id: str | NotGiven = NOT_GIVEN,
+        contour_idx: int | NotGiven = NOT_GIVEN,
+        gain: float | NotGiven = NOT_GIVEN,
+        geography: str | NotGiven = NOT_GIVEN,
+        geography_json: str | NotGiven = NOT_GIVEN,
+        geography_ndims: int | NotGiven = NOT_GIVEN,
+        geography_srid: int | NotGiven = NOT_GIVEN,
+        geography_text: str | NotGiven = NOT_GIVEN,
+        geography_type: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        region_name: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to take a single BeamContour as a POST body and ingest into
+        the database. A specific role is required to perform this service operation.
+        Please contact the UDL team for assistance.
+
+        Args:
+          classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
+
+          data_mode:
+              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.
+
+          id_beam: ID of the beam.
+
+          source: Source of the data.
+
+          type: The type of object represented in this record (BORESIGHT, CONTOUR, SVC AREA).
+              Boresight refers to the point of maximum/peak gain, and should not be confused
+              with the 'aim point' of the related beam. Gain contours are regions of coverage
+              referenced to the relative gain of the related beam. Service Areas are composed
+              of one or more service regions, with each region being either discrete point(s)
+              or a continuous contour.
+
+          id: Unique identifier of the record, auto-generated by the system.
+
+          contour_idx: The index number of this contour. The value is required if type = CONTOUR.
+
+          gain: The relative gain level in dB associated with this boresight or contour. Gain
+              does not apply to service area records. The value is required if type =
+              BORESIGHT or CONTOUR.
+
+          geography: GeoJSON or Well Known Text expression of the boresight point, service area point
+              or region, or the gain contour region in geographic longitude, latitude pairs.
+              Boresight and service area point(s) are represented as a 'Point' or
+              'MultiPoint', service areas and closed gain contours as 'Polygon', and open
+              contours as 'LineString'. This is an optional convenience field only used for
+              create operations. The system will auto-detect the format (Well Known Text or
+              GeoJSON) and populate both geographyText and geographyJson fields appropriately.
+              A create request must contain one of the geography, geographyText, or
+              geographyJson.
+
+          geography_json: Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON
+              representation of the geometry/geography, of the image as projected on the
+              ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST
+              or PUT request that also specifies a valid 'area' or 'atext' field.
+
+          geography_ndims: Number of dimensions of the geometry depicted by region.
+
+          geography_srid: Geographical spatial_ref_sys for region.
+
+          geography_text: Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known
+              Text representation of the geometry/geography, of the image as projected on the
+              ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored
+              if included with a POST or PUT request that also specifies a valid 'area' field.
+
+          geography_type: Type of region as projected.
+
+          origin: 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.
+
+          region_name: The region name within the service area.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._post(
+            "/udl/beamcontour",
+            body=maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "id_beam": id_beam,
+                    "source": source,
+                    "type": type,
+                    "id": id,
+                    "contour_idx": contour_idx,
+                    "gain": gain,
+                    "geography": geography,
+                    "geography_json": geography_json,
+                    "geography_ndims": geography_ndims,
+                    "geography_srid": geography_srid,
+                    "geography_text": geography_text,
+                    "geography_type": geography_type,
+                    "origin": origin,
+                    "region_name": region_name,
+                },
+                beam_contour_create_params.BeamContourCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def retrieve(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> BeamcontourFull:
+        """
+        Service operation to get a single BeamContour by its unique ID passed as a path
+        parameter.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/udl/beamcontour/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=BeamcontourFull,
+        )
+
+    def update(
+        self,
+        path_id: str,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        id_beam: str,
+        source: str,
+        type: Literal["BORESIGHT", "CONTOUR", "SVC AREA"],
+        body_id: str | NotGiven = NOT_GIVEN,
+        contour_idx: int | NotGiven = NOT_GIVEN,
+        gain: float | NotGiven = NOT_GIVEN,
+        geography: str | NotGiven = NOT_GIVEN,
+        geography_json: str | NotGiven = NOT_GIVEN,
+        geography_ndims: int | NotGiven = NOT_GIVEN,
+        geography_srid: int | NotGiven = NOT_GIVEN,
+        geography_text: str | NotGiven = NOT_GIVEN,
+        geography_type: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        region_name: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Service operation to update a single BeamContour.
+
+        A specific role is required to
+        perform this service operation. Please contact the UDL team for assistance.
+
+        Args:
+          classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
+
+          data_mode:
+              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.
+
+          id_beam: ID of the beam.
+
+          source: Source of the data.
+
+          type: The type of object represented in this record (BORESIGHT, CONTOUR, SVC AREA).
+              Boresight refers to the point of maximum/peak gain, and should not be confused
+              with the 'aim point' of the related beam. Gain contours are regions of coverage
+              referenced to the relative gain of the related beam. Service Areas are composed
+              of one or more service regions, with each region being either discrete point(s)
+              or a continuous contour.
+
+          body_id: Unique identifier of the record, auto-generated by the system.
+
+          contour_idx: The index number of this contour. The value is required if type = CONTOUR.
+
+          gain: The relative gain level in dB associated with this boresight or contour. Gain
+              does not apply to service area records. The value is required if type =
+              BORESIGHT or CONTOUR.
+
+          geography: GeoJSON or Well Known Text expression of the boresight point, service area point
+              or region, or the gain contour region in geographic longitude, latitude pairs.
+              Boresight and service area point(s) are represented as a 'Point' or
+              'MultiPoint', service areas and closed gain contours as 'Polygon', and open
+              contours as 'LineString'. This is an optional convenience field only used for
+              create operations. The system will auto-detect the format (Well Known Text or
+              GeoJSON) and populate both geographyText and geographyJson fields appropriately.
+              A create request must contain one of the geography, geographyText, or
+              geographyJson.
+
+          geography_json: Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON
+              representation of the geometry/geography, of the image as projected on the
+              ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST
+              or PUT request that also specifies a valid 'area' or 'atext' field.
+
+          geography_ndims: Number of dimensions of the geometry depicted by region.
+
+          geography_srid: Geographical spatial_ref_sys for region.
+
+          geography_text: Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known
+              Text representation of the geometry/geography, of the image as projected on the
+              ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored
+              if included with a POST or PUT request that also specifies a valid 'area' field.
+
+          geography_type: Type of region as projected.
+
+          origin: 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.
+
+          region_name: The region name within the service area.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not path_id:
+            raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._put(
+            f"/udl/beamcontour/{path_id}",
+            body=maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "id_beam": id_beam,
+                    "source": source,
+                    "type": type,
+                    "body_id": body_id,
+                    "contour_idx": contour_idx,
+                    "gain": gain,
+                    "geography": geography,
+                    "geography_json": geography_json,
+                    "geography_ndims": geography_ndims,
+                    "geography_srid": geography_srid,
+                    "geography_text": geography_text,
+                    "geography_type": geography_type,
+                    "origin": origin,
+                    "region_name": region_name,
+                },
+                beam_contour_update_params.BeamContourUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def list(
+        self,
+        *,
+        id_beam: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> BeamContourListResponse:
+        """
+        Service operation to dynamically query data by a variety of query parameters not
+        specified in this API documentation. See the queryhelp operation
+        (/udl/<datatype>/queryhelp) for more details on valid/required query
+        parameter information.
+
+        Args:
+          id_beam: ID of the beam.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            "/udl/beamcontour",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"id_beam": id_beam}, beam_contour_list_params.BeamContourListParams),
+            ),
+            cast_to=BeamContourListResponse,
+        )
+
+    def delete(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to delete a BeamContour object specified by the passed ID path
+        parameter. A specific role is required to perform this service operation. Please
+        contact the UDL team for assistance.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            f"/udl/beamcontour/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def count(
+        self,
+        *,
+        id_beam: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> str:
+        """
+        Service operation to return the count of records satisfying the specified query
+        parameters. This operation is useful to determine how many records pass a
+        particular query criteria without retrieving large amounts of data. See the
+        queryhelp operation (/udl/<datatype>/queryhelp) for more details on
+        valid/required query parameter information.
+
+        Args:
+          id_beam: ID of the beam.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "text/plain", **(extra_headers or {})}
+        return self._get(
+            "/udl/beamcontour/count",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"id_beam": id_beam}, beam_contour_count_params.BeamContourCountParams),
+            ),
+            cast_to=str,
+        )
+
+    def create_bulk(
+        self,
+        *,
+        body: Iterable[beam_contour_create_bulk_params.Body],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to take a list of BeamContours as a POST body and ingest into
+        the database. This operation is not intended to be used for automated feeds into
+        UDL. Data providers should contact the UDL team for specific role assignments
+        and for instructions on setting up a permanent feed through an alternate
+        mechanism.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._post(
+            "/udl/beamcontour/createBulk",
+            body=maybe_transform(body, Iterable[beam_contour_create_bulk_params.Body]),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def query_help(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to provide detailed information on available dynamic query
+        parameters for a particular data type.
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            "/udl/beamcontour/queryhelp",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def tuple(
+        self,
+        *,
+        columns: str,
+        id_beam: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> BeamContourTupleResponse:
+        """
+        Service operation to dynamically query data and only return specified
+        columns/fields. Requested columns are specified by the 'columns' query parameter
+        and should be a comma separated list of valid fields for the specified data
+        type. classificationMarking is always returned. See the queryhelp operation
+        (/udl/<datatype>/queryhelp) for more details on valid/required query parameter
+        information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5
+        hours would return the satNo and period of elsets with an epoch greater than 5
+        hours ago.
+
+        Args:
+          columns: 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.
+
+          id_beam: ID of the beam.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            "/udl/beamcontour/tuple",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "columns": columns,
+                        "id_beam": id_beam,
+                    },
+                    beam_contour_tuple_params.BeamContourTupleParams,
+                ),
+            ),
+            cast_to=BeamContourTupleResponse,
+        )
+
+
+class AsyncBeamContoursResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncBeamContoursResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/rsivilli-bluestaq/udl-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return AsyncBeamContoursResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncBeamContoursResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/rsivilli-bluestaq/udl-python-sdk#with_streaming_response
+        """
+        return AsyncBeamContoursResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        id_beam: str,
+        source: str,
+        type: Literal["BORESIGHT", "CONTOUR", "SVC AREA"],
+        id: str | NotGiven = NOT_GIVEN,
+        contour_idx: int | NotGiven = NOT_GIVEN,
+        gain: float | NotGiven = NOT_GIVEN,
+        geography: str | NotGiven = NOT_GIVEN,
+        geography_json: str | NotGiven = NOT_GIVEN,
+        geography_ndims: int | NotGiven = NOT_GIVEN,
+        geography_srid: int | NotGiven = NOT_GIVEN,
+        geography_text: str | NotGiven = NOT_GIVEN,
+        geography_type: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        region_name: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to take a single BeamContour as a POST body and ingest into
+        the database. A specific role is required to perform this service operation.
+        Please contact the UDL team for assistance.
+
+        Args:
+          classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
+
+          data_mode:
+              Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+              EXERCISE:&nbsp;Data pertaining to a government or military exercise. The data
+              may include both real and simulated data.
+
+              REAL:&nbsp;Data collected or produced that pertains to real-world objects,
+              events, and analysis.
+
+              SIMULATED:&nbsp;Synthetic data generated by a model to mimic real-world
+              datasets.
+
+              TEST:&nbsp;Specific datasets used to evaluate compliance with specifications and
+              requirements, and for validating technical, functional, and performance
+              characteristics.
+
+          id_beam: ID of the beam.
+
+          source: Source of the data.
+
+          type: The type of object represented in this record (BORESIGHT, CONTOUR, SVC AREA).
+              Boresight refers to the point of maximum/peak gain, and should not be confused
+              with the 'aim point' of the related beam. Gain contours are regions of coverage
+              referenced to the relative gain of the related beam. Service Areas are composed
+              of one or more service regions, with each region being either discrete point(s)
+              or a continuous contour.
+
+          id: Unique identifier of the record, auto-generated by the system.
+
+          contour_idx: The index number of this contour. The value is required if type = CONTOUR.
+
+          gain: The relative gain level in dB associated with this boresight or contour. Gain
+              does not apply to service area records. The value is required if type =
+              BORESIGHT or CONTOUR.
+
+          geography: GeoJSON or Well Known Text expression of the boresight point, service area point
+              or region, or the gain contour region in geographic longitude, latitude pairs.
+              Boresight and service area point(s) are represented as a 'Point' or
+              'MultiPoint', service areas and closed gain contours as 'Polygon', and open
+              contours as 'LineString'. This is an optional convenience field only used for
+              create operations. The system will auto-detect the format (Well Known Text or
+              GeoJSON) and populate both geographyText and geographyJson fields appropriately.
+              A create request must contain one of the geography, geographyText, or
+              geographyJson.
+
+          geography_json: Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON
+              representation of the geometry/geography, of the image as projected on the
+              ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST
+              or PUT request that also specifies a valid 'area' or 'atext' field.
+
+          geography_ndims: Number of dimensions of the geometry depicted by region.
+
+          geography_srid: Geographical spatial_ref_sys for region.
+
+          geography_text: Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known
+              Text representation of the geometry/geography, of the image as projected on the
+              ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored
+              if included with a POST or PUT request that also specifies a valid 'area' field.
+
+          geography_type: Type of region as projected.
+
+          origin: 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.
+
+          region_name: The region name within the service area.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._post(
+            "/udl/beamcontour",
+            body=await async_maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "id_beam": id_beam,
+                    "source": source,
+                    "type": type,
+                    "id": id,
+                    "contour_idx": contour_idx,
+                    "gain": gain,
+                    "geography": geography,
+                    "geography_json": geography_json,
+                    "geography_ndims": geography_ndims,
+                    "geography_srid": geography_srid,
+                    "geography_text": geography_text,
+                    "geography_type": geography_type,
+                    "origin": origin,
+                    "region_name": region_name,
+                },
+                beam_contour_create_params.BeamContourCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> BeamcontourFull:
+        """
+        Service operation to get a single BeamContour by its unique ID passed as a path
+        parameter.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/udl/beamcontour/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=BeamcontourFull,
+        )
+
+    async def update(
+        self,
+        path_id: str,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        id_beam: str,
+        source: str,
+        type: Literal["BORESIGHT", "CONTOUR", "SVC AREA"],
+        body_id: str | NotGiven = NOT_GIVEN,
+        contour_idx: int | NotGiven = NOT_GIVEN,
+        gain: float | NotGiven = NOT_GIVEN,
+        geography: str | NotGiven = NOT_GIVEN,
+        geography_json: str | NotGiven = NOT_GIVEN,
+        geography_ndims: int | NotGiven = NOT_GIVEN,
+        geography_srid: int | NotGiven = NOT_GIVEN,
+        geography_text: str | NotGiven = NOT_GIVEN,
+        geography_type: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        region_name: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Service operation to update a single BeamContour.
+
+        A specific role is required to
+        perform this service operation. Please contact the UDL team for assistance.
+
+        Args:
+          classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
+
+          data_mode:
+              Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
+
+              EXERCISE:&nbsp;Data pertaining to a government or military exercise. The data
+              may include both real and simulated data.
+
+              REAL:&nbsp;Data collected or produced that pertains to real-world objects,
+              events, and analysis.
+
+              SIMULATED:&nbsp;Synthetic data generated by a model to mimic real-world
+              datasets.
+
+              TEST:&nbsp;Specific datasets used to evaluate compliance with specifications and
+              requirements, and for validating technical, functional, and performance
+              characteristics.
+
+          id_beam: ID of the beam.
+
+          source: Source of the data.
+
+          type: The type of object represented in this record (BORESIGHT, CONTOUR, SVC AREA).
+              Boresight refers to the point of maximum/peak gain, and should not be confused
+              with the 'aim point' of the related beam. Gain contours are regions of coverage
+              referenced to the relative gain of the related beam. Service Areas are composed
+              of one or more service regions, with each region being either discrete point(s)
+              or a continuous contour.
+
+          body_id: Unique identifier of the record, auto-generated by the system.
+
+          contour_idx: The index number of this contour. The value is required if type = CONTOUR.
+
+          gain: The relative gain level in dB associated with this boresight or contour. Gain
+              does not apply to service area records. The value is required if type =
+              BORESIGHT or CONTOUR.
+
+          geography: GeoJSON or Well Known Text expression of the boresight point, service area point
+              or region, or the gain contour region in geographic longitude, latitude pairs.
+              Boresight and service area point(s) are represented as a 'Point' or
+              'MultiPoint', service areas and closed gain contours as 'Polygon', and open
+              contours as 'LineString'. This is an optional convenience field only used for
+              create operations. The system will auto-detect the format (Well Known Text or
+              GeoJSON) and populate both geographyText and geographyJson fields appropriately.
+              A create request must contain one of the geography, geographyText, or
+              geographyJson.
+
+          geography_json: Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON
+              representation of the geometry/geography, of the image as projected on the
+              ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST
+              or PUT request that also specifies a valid 'area' or 'atext' field.
+
+          geography_ndims: Number of dimensions of the geometry depicted by region.
+
+          geography_srid: Geographical spatial_ref_sys for region.
+
+          geography_text: Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known
+              Text representation of the geometry/geography, of the image as projected on the
+              ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored
+              if included with a POST or PUT request that also specifies a valid 'area' field.
+
+          geography_type: Type of region as projected.
+
+          origin: 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.
+
+          region_name: The region name within the service area.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not path_id:
+            raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._put(
+            f"/udl/beamcontour/{path_id}",
+            body=await async_maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "id_beam": id_beam,
+                    "source": source,
+                    "type": type,
+                    "body_id": body_id,
+                    "contour_idx": contour_idx,
+                    "gain": gain,
+                    "geography": geography,
+                    "geography_json": geography_json,
+                    "geography_ndims": geography_ndims,
+                    "geography_srid": geography_srid,
+                    "geography_text": geography_text,
+                    "geography_type": geography_type,
+                    "origin": origin,
+                    "region_name": region_name,
+                },
+                beam_contour_update_params.BeamContourUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def list(
+        self,
+        *,
+        id_beam: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> BeamContourListResponse:
+        """
+        Service operation to dynamically query data by a variety of query parameters not
+        specified in this API documentation. See the queryhelp operation
+        (/udl/&lt;datatype&gt;/queryhelp) for more details on valid/required query
+        parameter information.
+
+        Args:
+          id_beam: ID of the beam.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            "/udl/beamcontour",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform({"id_beam": id_beam}, beam_contour_list_params.BeamContourListParams),
+            ),
+            cast_to=BeamContourListResponse,
+        )
+
+    async def delete(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to delete a BeamContour object specified by the passed ID path
+        parameter. A specific role is required to perform this service operation. Please
+        contact the UDL team for assistance.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            f"/udl/beamcontour/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def count(
+        self,
+        *,
+        id_beam: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> str:
+        """
+        Service operation to return the count of records satisfying the specified query
+        parameters. This operation is useful to determine how many records pass a
+        particular query criteria without retrieving large amounts of data. See the
+        queryhelp operation (/udl/&lt;datatype&gt;/queryhelp) for more details on
+        valid/required query parameter information.
+
+        Args:
+          id_beam: ID of the beam.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "text/plain", **(extra_headers or {})}
+        return await self._get(
+            "/udl/beamcontour/count",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"id_beam": id_beam}, beam_contour_count_params.BeamContourCountParams
+                ),
+            ),
+            cast_to=str,
+        )
+
+    async def create_bulk(
+        self,
+        *,
+        body: Iterable[beam_contour_create_bulk_params.Body],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to take a list of BeamContours as a POST body and ingest into
+        the database. This operation is not intended to be used for automated feeds into
+        UDL. Data providers should contact the UDL team for specific role assignments
+        and for instructions on setting up a permanent feed through an alternate
+        mechanism.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._post(
+            "/udl/beamcontour/createBulk",
+            body=await async_maybe_transform(body, Iterable[beam_contour_create_bulk_params.Body]),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def query_help(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Service operation to provide detailed information on available dynamic query
+        parameters for a particular data type.
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            "/udl/beamcontour/queryhelp",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def tuple(
+        self,
+        *,
+        columns: str,
+        id_beam: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> BeamContourTupleResponse:
+        """
+        Service operation to dynamically query data and only return specified
+        columns/fields. Requested columns are specified by the 'columns' query parameter
+        and should be a comma separated list of valid fields for the specified data
+        type. classificationMarking is always returned. See the queryhelp operation
+        (/udl/<datatype>/queryhelp) for more details on valid/required query parameter
+        information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5
+        hours would return the satNo and period of elsets with an epoch greater than 5
+        hours ago.
+
+        Args:
+          columns: 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.
+
+          id_beam: ID of the beam.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            "/udl/beamcontour/tuple",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "columns": columns,
+                        "id_beam": id_beam,
+                    },
+                    beam_contour_tuple_params.BeamContourTupleParams,
+                ),
+            ),
+            cast_to=BeamContourTupleResponse,
+        )
+
+
+class BeamContoursResourceWithRawResponse:
+    def __init__(self, beam_contours: BeamContoursResource) -> None:
+        self._beam_contours = beam_contours
+
+        self.create = to_raw_response_wrapper(
+            beam_contours.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            beam_contours.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            beam_contours.update,
+        )
+        self.list = to_raw_response_wrapper(
+            beam_contours.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            beam_contours.delete,
+        )
+        self.count = to_raw_response_wrapper(
+            beam_contours.count,
+        )
+        self.create_bulk = to_raw_response_wrapper(
+            beam_contours.create_bulk,
+        )
+        self.query_help = to_raw_response_wrapper(
+            beam_contours.query_help,
+        )
+        self.tuple = to_raw_response_wrapper(
+            beam_contours.tuple,
+        )
+
+
+class AsyncBeamContoursResourceWithRawResponse:
+    def __init__(self, beam_contours: AsyncBeamContoursResource) -> None:
+        self._beam_contours = beam_contours
+
+        self.create = async_to_raw_response_wrapper(
+            beam_contours.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            beam_contours.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            beam_contours.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            beam_contours.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            beam_contours.delete,
+        )
+        self.count = async_to_raw_response_wrapper(
+            beam_contours.count,
+        )
+        self.create_bulk = async_to_raw_response_wrapper(
+            beam_contours.create_bulk,
+        )
+        self.query_help = async_to_raw_response_wrapper(
+            beam_contours.query_help,
+        )
+        self.tuple = async_to_raw_response_wrapper(
+            beam_contours.tuple,
+        )
+
+
+class BeamContoursResourceWithStreamingResponse:
+    def __init__(self, beam_contours: BeamContoursResource) -> None:
+        self._beam_contours = beam_contours
+
+        self.create = to_streamed_response_wrapper(
+            beam_contours.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            beam_contours.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            beam_contours.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            beam_contours.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            beam_contours.delete,
+        )
+        self.count = to_streamed_response_wrapper(
+            beam_contours.count,
+        )
+        self.create_bulk = to_streamed_response_wrapper(
+            beam_contours.create_bulk,
+        )
+        self.query_help = to_streamed_response_wrapper(
+            beam_contours.query_help,
+        )
+        self.tuple = to_streamed_response_wrapper(
+            beam_contours.tuple,
+        )
+
+
+class AsyncBeamContoursResourceWithStreamingResponse:
+    def __init__(self, beam_contours: AsyncBeamContoursResource) -> None:
+        self._beam_contours = beam_contours
+
+        self.create = async_to_streamed_response_wrapper(
+            beam_contours.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            beam_contours.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            beam_contours.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            beam_contours.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            beam_contours.delete,
+        )
+        self.count = async_to_streamed_response_wrapper(
+            beam_contours.count,
+        )
+        self.create_bulk = async_to_streamed_response_wrapper(
+            beam_contours.create_bulk,
+        )
+        self.query_help = async_to_streamed_response_wrapper(
+            beam_contours.query_help,
+        )
+        self.tuple = async_to_streamed_response_wrapper(
+            beam_contours.tuple,
+        )