udl-sdk 0.1.0a1__py3-none-any.whl

unifieddatalibrary/resources/sensorplan/sensorplan.py

@@ -0,0 +1,1281 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Iterable
+from datetime import datetime
+from typing_extensions import Literal
+
+import httpx
+
+from ...types import (
+    sensorplan_list_params,
+    sensorplan_count_params,
+    sensorplan_tuple_params,
+    sensorplan_create_params,
+    sensorplan_update_params,
+    sensorplan_unvalidated_publish_params,
+)
+from .history import (
+    HistoryResource,
+    AsyncHistoryResource,
+    HistoryResourceWithRawResponse,
+    AsyncHistoryResourceWithRawResponse,
+    HistoryResourceWithStreamingResponse,
+    AsyncHistoryResourceWithStreamingResponse,
+)
+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.sensorplan_list_response import SensorplanListResponse
+from ...types.sensorplan_tuple_response import SensorplanTupleResponse
+from ...types.udl.sensorplan.sensorplan_full import SensorplanFull
+
+__all__ = ["SensorplanResource", "AsyncSensorplanResource"]
+
+
+class SensorplanResource(SyncAPIResource):
+    @cached_property
+    def history(self) -> HistoryResource:
+        return HistoryResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> SensorplanResourceWithRawResponse:
+        """
+        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 SensorplanResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> SensorplanResourceWithStreamingResponse:
+        """
+        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 SensorplanResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        rec_type: str,
+        source: str,
+        start_time: Union[str, datetime],
+        type: str,
+        id: str | NotGiven = NOT_GIVEN,
+        collect_requests: Iterable[sensorplan_create_params.CollectRequest] | NotGiven = NOT_GIVEN,
+        customer: str | NotGiven = NOT_GIVEN,
+        end_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        id_sensor: str | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        orig_sensor_id: str | NotGiven = NOT_GIVEN,
+        purpose: str | NotGiven = NOT_GIVEN,
+        req_total: int | NotGiven = NOT_GIVEN,
+        sen_network: str | NotGiven = NOT_GIVEN,
+        status: str | NotGiven = NOT_GIVEN,
+        tags: List[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 sensor plan 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.
+
+          rec_type: The type of records that comprise this parent set (COLLECT, CONTACT).
+
+          source: Source of the data.
+
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+
+          type: The type of this sensor plan/schedule (PLAN, REQUEST, SCHEDULE).
+
+          id: Unique identifier of the record, auto-generated by the system.
+
+          collect_requests: The list of collect requests belonging to the SensorPlan. Each collect request
+              is associated with a parent SensorPlan via the IdPlan. If provided, the list
+              must have the same size as reqTotal.
+
+          customer: The customer for this plan or schedule.
+
+          end_time: The end time of the plan or schedule, in ISO 8601 UTC format.
+
+          id_sensor: Unique identifier of the requested/schedule/planned sensor associated with this
+              request.
+
+          name: Name associated with this plan or schedule.
+
+          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.
+
+          orig_sensor_id: Optional identifier provided by the source to indicate the sensor identifier
+              requested/scheduled/planned for this request. This may be an internal identifier
+              and not necessarily a valid sensor ID.
+
+          purpose: The purpose/description of this plan or schedule.
+
+          req_total: The total number of requests contained in this plan or schedule. Value of this
+              field must match the size of collectRequest list if the list is provided and can
+              be null or any value otherwise.
+
+          sen_network: The sensor or ground network associated with this plan or schedule.
+
+          status: The status of this plan or schedule (ACCEPTED, APPROVED, COMPLETED, PROPOSED,
+              REJECTED, REQUESTED, SCHEDULED).
+
+          tags: Optional array of provider/source specific tags for this data, where each
+              element is no longer than 32 characters, used for implementing data owner
+              conditional access controls to restrict access to the data. Should be left null
+              by data providers unless conditional access controls are coordinated with the
+              UDL team.
+
+          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/sensorplan",
+            body=maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "rec_type": rec_type,
+                    "source": source,
+                    "start_time": start_time,
+                    "type": type,
+                    "id": id,
+                    "collect_requests": collect_requests,
+                    "customer": customer,
+                    "end_time": end_time,
+                    "id_sensor": id_sensor,
+                    "name": name,
+                    "origin": origin,
+                    "orig_sensor_id": orig_sensor_id,
+                    "purpose": purpose,
+                    "req_total": req_total,
+                    "sen_network": sen_network,
+                    "status": status,
+                    "tags": tags,
+                },
+                sensorplan_create_params.SensorplanCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def update(
+        self,
+        path_id: str,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        rec_type: str,
+        source: str,
+        start_time: Union[str, datetime],
+        type: str,
+        body_id: str | NotGiven = NOT_GIVEN,
+        collect_requests: Iterable[sensorplan_update_params.CollectRequest] | NotGiven = NOT_GIVEN,
+        customer: str | NotGiven = NOT_GIVEN,
+        end_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        id_sensor: str | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        orig_sensor_id: str | NotGiven = NOT_GIVEN,
+        purpose: str | NotGiven = NOT_GIVEN,
+        req_total: int | NotGiven = NOT_GIVEN,
+        sen_network: str | NotGiven = NOT_GIVEN,
+        status: str | NotGiven = NOT_GIVEN,
+        tags: List[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 SensorPlan.
+
+        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.
+
+          rec_type: The type of records that comprise this parent set (COLLECT, CONTACT).
+
+          source: Source of the data.
+
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+
+          type: The type of this sensor plan/schedule (PLAN, REQUEST, SCHEDULE).
+
+          body_id: Unique identifier of the record, auto-generated by the system.
+
+          collect_requests: The list of collect requests belonging to the SensorPlan. Each collect request
+              is associated with a parent SensorPlan via the IdPlan. If provided, the list
+              must have the same size as reqTotal.
+
+          customer: The customer for this plan or schedule.
+
+          end_time: The end time of the plan or schedule, in ISO 8601 UTC format.
+
+          id_sensor: Unique identifier of the requested/schedule/planned sensor associated with this
+              request.
+
+          name: Name associated with this plan or schedule.
+
+          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.
+
+          orig_sensor_id: Optional identifier provided by the source to indicate the sensor identifier
+              requested/scheduled/planned for this request. This may be an internal identifier
+              and not necessarily a valid sensor ID.
+
+          purpose: The purpose/description of this plan or schedule.
+
+          req_total: The total number of requests contained in this plan or schedule. Value of this
+              field must match the size of collectRequest list if the list is provided and can
+              be null or any value otherwise.
+
+          sen_network: The sensor or ground network associated with this plan or schedule.
+
+          status: The status of this plan or schedule (ACCEPTED, APPROVED, COMPLETED, PROPOSED,
+              REJECTED, REQUESTED, SCHEDULED).
+
+          tags: Optional array of provider/source specific tags for this data, where each
+              element is no longer than 32 characters, used for implementing data owner
+              conditional access controls to restrict access to the data. Should be left null
+              by data providers unless conditional access controls are coordinated with the
+              UDL team.
+
+          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/sensorplan/{path_id}",
+            body=maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "rec_type": rec_type,
+                    "source": source,
+                    "start_time": start_time,
+                    "type": type,
+                    "body_id": body_id,
+                    "collect_requests": collect_requests,
+                    "customer": customer,
+                    "end_time": end_time,
+                    "id_sensor": id_sensor,
+                    "name": name,
+                    "origin": origin,
+                    "orig_sensor_id": orig_sensor_id,
+                    "purpose": purpose,
+                    "req_total": req_total,
+                    "sen_network": sen_network,
+                    "status": status,
+                    "tags": tags,
+                },
+                sensorplan_update_params.SensorplanUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def list(
+        self,
+        *,
+        start_time: Union[str, datetime],
+        # 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,
+    ) -> SensorplanListResponse:
+        """
+        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:
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+              (YYYY-MM-DDTHH:MM:SS.ssssssZ)
+
+          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/sensorplan",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"start_time": start_time}, sensorplan_list_params.SensorplanListParams),
+            ),
+            cast_to=SensorplanListResponse,
+        )
+
+    def count(
+        self,
+        *,
+        start_time: Union[str, datetime],
+        # 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:
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+              (YYYY-MM-DDTHH:MM:SS.ssssssZ)
+
+          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/sensorplan/count",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"start_time": start_time}, sensorplan_count_params.SensorplanCountParams),
+            ),
+            cast_to=str,
+        )
+
+    def get(
+        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,
+    ) -> SensorplanFull:
+        """
+        Service operation to get a single SensorPlan 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/sensorplan/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorplanFull,
+        )
+
+    def queryhelp(
+        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/sensorplan/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,
+        start_time: Union[str, datetime],
+        # 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,
+    ) -> SensorplanTupleResponse:
+        """
+        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.
+
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+              (YYYY-MM-DDTHH:MM:SS.ssssssZ)
+
+          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/sensorplan/tuple",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "columns": columns,
+                        "start_time": start_time,
+                    },
+                    sensorplan_tuple_params.SensorplanTupleParams,
+                ),
+            ),
+            cast_to=SensorplanTupleResponse,
+        )
+
+    def unvalidated_publish(
+        self,
+        *,
+        body: Iterable[sensorplan_unvalidated_publish_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 one or more sensorplan record(s) as a POST body and
+        ingest into the database. This operation is intended to be used for automated
+        feeds into UDL. 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
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._post(
+            "/filedrop/udl-sensorplan",
+            body=maybe_transform(body, Iterable[sensorplan_unvalidated_publish_params.Body]),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncSensorplanResource(AsyncAPIResource):
+    @cached_property
+    def history(self) -> AsyncHistoryResource:
+        return AsyncHistoryResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncSensorplanResourceWithRawResponse:
+        """
+        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 AsyncSensorplanResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncSensorplanResourceWithStreamingResponse:
+        """
+        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 AsyncSensorplanResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        rec_type: str,
+        source: str,
+        start_time: Union[str, datetime],
+        type: str,
+        id: str | NotGiven = NOT_GIVEN,
+        collect_requests: Iterable[sensorplan_create_params.CollectRequest] | NotGiven = NOT_GIVEN,
+        customer: str | NotGiven = NOT_GIVEN,
+        end_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        id_sensor: str | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        orig_sensor_id: str | NotGiven = NOT_GIVEN,
+        purpose: str | NotGiven = NOT_GIVEN,
+        req_total: int | NotGiven = NOT_GIVEN,
+        sen_network: str | NotGiven = NOT_GIVEN,
+        status: str | NotGiven = NOT_GIVEN,
+        tags: List[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 sensor plan 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.
+
+          rec_type: The type of records that comprise this parent set (COLLECT, CONTACT).
+
+          source: Source of the data.
+
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+
+          type: The type of this sensor plan/schedule (PLAN, REQUEST, SCHEDULE).
+
+          id: Unique identifier of the record, auto-generated by the system.
+
+          collect_requests: The list of collect requests belonging to the SensorPlan. Each collect request
+              is associated with a parent SensorPlan via the IdPlan. If provided, the list
+              must have the same size as reqTotal.
+
+          customer: The customer for this plan or schedule.
+
+          end_time: The end time of the plan or schedule, in ISO 8601 UTC format.
+
+          id_sensor: Unique identifier of the requested/schedule/planned sensor associated with this
+              request.
+
+          name: Name associated with this plan or schedule.
+
+          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.
+
+          orig_sensor_id: Optional identifier provided by the source to indicate the sensor identifier
+              requested/scheduled/planned for this request. This may be an internal identifier
+              and not necessarily a valid sensor ID.
+
+          purpose: The purpose/description of this plan or schedule.
+
+          req_total: The total number of requests contained in this plan or schedule. Value of this
+              field must match the size of collectRequest list if the list is provided and can
+              be null or any value otherwise.
+
+          sen_network: The sensor or ground network associated with this plan or schedule.
+
+          status: The status of this plan or schedule (ACCEPTED, APPROVED, COMPLETED, PROPOSED,
+              REJECTED, REQUESTED, SCHEDULED).
+
+          tags: Optional array of provider/source specific tags for this data, where each
+              element is no longer than 32 characters, used for implementing data owner
+              conditional access controls to restrict access to the data. Should be left null
+              by data providers unless conditional access controls are coordinated with the
+              UDL team.
+
+          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/sensorplan",
+            body=await async_maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "rec_type": rec_type,
+                    "source": source,
+                    "start_time": start_time,
+                    "type": type,
+                    "id": id,
+                    "collect_requests": collect_requests,
+                    "customer": customer,
+                    "end_time": end_time,
+                    "id_sensor": id_sensor,
+                    "name": name,
+                    "origin": origin,
+                    "orig_sensor_id": orig_sensor_id,
+                    "purpose": purpose,
+                    "req_total": req_total,
+                    "sen_network": sen_network,
+                    "status": status,
+                    "tags": tags,
+                },
+                sensorplan_create_params.SensorplanCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def update(
+        self,
+        path_id: str,
+        *,
+        classification_marking: str,
+        data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
+        rec_type: str,
+        source: str,
+        start_time: Union[str, datetime],
+        type: str,
+        body_id: str | NotGiven = NOT_GIVEN,
+        collect_requests: Iterable[sensorplan_update_params.CollectRequest] | NotGiven = NOT_GIVEN,
+        customer: str | NotGiven = NOT_GIVEN,
+        end_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        id_sensor: str | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        origin: str | NotGiven = NOT_GIVEN,
+        orig_sensor_id: str | NotGiven = NOT_GIVEN,
+        purpose: str | NotGiven = NOT_GIVEN,
+        req_total: int | NotGiven = NOT_GIVEN,
+        sen_network: str | NotGiven = NOT_GIVEN,
+        status: str | NotGiven = NOT_GIVEN,
+        tags: List[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 SensorPlan.
+
+        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.
+
+          rec_type: The type of records that comprise this parent set (COLLECT, CONTACT).
+
+          source: Source of the data.
+
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+
+          type: The type of this sensor plan/schedule (PLAN, REQUEST, SCHEDULE).
+
+          body_id: Unique identifier of the record, auto-generated by the system.
+
+          collect_requests: The list of collect requests belonging to the SensorPlan. Each collect request
+              is associated with a parent SensorPlan via the IdPlan. If provided, the list
+              must have the same size as reqTotal.
+
+          customer: The customer for this plan or schedule.
+
+          end_time: The end time of the plan or schedule, in ISO 8601 UTC format.
+
+          id_sensor: Unique identifier of the requested/schedule/planned sensor associated with this
+              request.
+
+          name: Name associated with this plan or schedule.
+
+          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.
+
+          orig_sensor_id: Optional identifier provided by the source to indicate the sensor identifier
+              requested/scheduled/planned for this request. This may be an internal identifier
+              and not necessarily a valid sensor ID.
+
+          purpose: The purpose/description of this plan or schedule.
+
+          req_total: The total number of requests contained in this plan or schedule. Value of this
+              field must match the size of collectRequest list if the list is provided and can
+              be null or any value otherwise.
+
+          sen_network: The sensor or ground network associated with this plan or schedule.
+
+          status: The status of this plan or schedule (ACCEPTED, APPROVED, COMPLETED, PROPOSED,
+              REJECTED, REQUESTED, SCHEDULED).
+
+          tags: Optional array of provider/source specific tags for this data, where each
+              element is no longer than 32 characters, used for implementing data owner
+              conditional access controls to restrict access to the data. Should be left null
+              by data providers unless conditional access controls are coordinated with the
+              UDL team.
+
+          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/sensorplan/{path_id}",
+            body=await async_maybe_transform(
+                {
+                    "classification_marking": classification_marking,
+                    "data_mode": data_mode,
+                    "rec_type": rec_type,
+                    "source": source,
+                    "start_time": start_time,
+                    "type": type,
+                    "body_id": body_id,
+                    "collect_requests": collect_requests,
+                    "customer": customer,
+                    "end_time": end_time,
+                    "id_sensor": id_sensor,
+                    "name": name,
+                    "origin": origin,
+                    "orig_sensor_id": orig_sensor_id,
+                    "purpose": purpose,
+                    "req_total": req_total,
+                    "sen_network": sen_network,
+                    "status": status,
+                    "tags": tags,
+                },
+                sensorplan_update_params.SensorplanUpdateParams,
+            ),
+            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,
+        *,
+        start_time: Union[str, datetime],
+        # 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,
+    ) -> SensorplanListResponse:
+        """
+        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:
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+              (YYYY-MM-DDTHH:MM:SS.ssssssZ)
+
+          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/sensorplan",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"start_time": start_time}, sensorplan_list_params.SensorplanListParams
+                ),
+            ),
+            cast_to=SensorplanListResponse,
+        )
+
+    async def count(
+        self,
+        *,
+        start_time: Union[str, datetime],
+        # 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:
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+              (YYYY-MM-DDTHH:MM:SS.ssssssZ)
+
+          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/sensorplan/count",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"start_time": start_time}, sensorplan_count_params.SensorplanCountParams
+                ),
+            ),
+            cast_to=str,
+        )
+
+    async def get(
+        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,
+    ) -> SensorplanFull:
+        """
+        Service operation to get a single SensorPlan 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/sensorplan/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorplanFull,
+        )
+
+    async def queryhelp(
+        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/sensorplan/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,
+        start_time: Union[str, datetime],
+        # 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,
+    ) -> SensorplanTupleResponse:
+        """
+        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.
+
+          start_time: The start time of the plan or schedule, in ISO 8601 UTC format.
+              (YYYY-MM-DDTHH:MM:SS.ssssssZ)
+
+          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/sensorplan/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,
+                        "start_time": start_time,
+                    },
+                    sensorplan_tuple_params.SensorplanTupleParams,
+                ),
+            ),
+            cast_to=SensorplanTupleResponse,
+        )
+
+    async def unvalidated_publish(
+        self,
+        *,
+        body: Iterable[sensorplan_unvalidated_publish_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 one or more sensorplan record(s) as a POST body and
+        ingest into the database. This operation is intended to be used for automated
+        feeds into UDL. 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
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._post(
+            "/filedrop/udl-sensorplan",
+            body=await async_maybe_transform(body, Iterable[sensorplan_unvalidated_publish_params.Body]),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class SensorplanResourceWithRawResponse:
+    def __init__(self, sensorplan: SensorplanResource) -> None:
+        self._sensorplan = sensorplan
+
+        self.create = to_raw_response_wrapper(
+            sensorplan.create,
+        )
+        self.update = to_raw_response_wrapper(
+            sensorplan.update,
+        )
+        self.list = to_raw_response_wrapper(
+            sensorplan.list,
+        )
+        self.count = to_raw_response_wrapper(
+            sensorplan.count,
+        )
+        self.get = to_raw_response_wrapper(
+            sensorplan.get,
+        )
+        self.queryhelp = to_raw_response_wrapper(
+            sensorplan.queryhelp,
+        )
+        self.tuple = to_raw_response_wrapper(
+            sensorplan.tuple,
+        )
+        self.unvalidated_publish = to_raw_response_wrapper(
+            sensorplan.unvalidated_publish,
+        )
+
+    @cached_property
+    def history(self) -> HistoryResourceWithRawResponse:
+        return HistoryResourceWithRawResponse(self._sensorplan.history)
+
+
+class AsyncSensorplanResourceWithRawResponse:
+    def __init__(self, sensorplan: AsyncSensorplanResource) -> None:
+        self._sensorplan = sensorplan
+
+        self.create = async_to_raw_response_wrapper(
+            sensorplan.create,
+        )
+        self.update = async_to_raw_response_wrapper(
+            sensorplan.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            sensorplan.list,
+        )
+        self.count = async_to_raw_response_wrapper(
+            sensorplan.count,
+        )
+        self.get = async_to_raw_response_wrapper(
+            sensorplan.get,
+        )
+        self.queryhelp = async_to_raw_response_wrapper(
+            sensorplan.queryhelp,
+        )
+        self.tuple = async_to_raw_response_wrapper(
+            sensorplan.tuple,
+        )
+        self.unvalidated_publish = async_to_raw_response_wrapper(
+            sensorplan.unvalidated_publish,
+        )
+
+    @cached_property
+    def history(self) -> AsyncHistoryResourceWithRawResponse:
+        return AsyncHistoryResourceWithRawResponse(self._sensorplan.history)
+
+
+class SensorplanResourceWithStreamingResponse:
+    def __init__(self, sensorplan: SensorplanResource) -> None:
+        self._sensorplan = sensorplan
+
+        self.create = to_streamed_response_wrapper(
+            sensorplan.create,
+        )
+        self.update = to_streamed_response_wrapper(
+            sensorplan.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            sensorplan.list,
+        )
+        self.count = to_streamed_response_wrapper(
+            sensorplan.count,
+        )
+        self.get = to_streamed_response_wrapper(
+            sensorplan.get,
+        )
+        self.queryhelp = to_streamed_response_wrapper(
+            sensorplan.queryhelp,
+        )
+        self.tuple = to_streamed_response_wrapper(
+            sensorplan.tuple,
+        )
+        self.unvalidated_publish = to_streamed_response_wrapper(
+            sensorplan.unvalidated_publish,
+        )
+
+    @cached_property
+    def history(self) -> HistoryResourceWithStreamingResponse:
+        return HistoryResourceWithStreamingResponse(self._sensorplan.history)
+
+
+class AsyncSensorplanResourceWithStreamingResponse:
+    def __init__(self, sensorplan: AsyncSensorplanResource) -> None:
+        self._sensorplan = sensorplan
+
+        self.create = async_to_streamed_response_wrapper(
+            sensorplan.create,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            sensorplan.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            sensorplan.list,
+        )
+        self.count = async_to_streamed_response_wrapper(
+            sensorplan.count,
+        )
+        self.get = async_to_streamed_response_wrapper(
+            sensorplan.get,
+        )
+        self.queryhelp = async_to_streamed_response_wrapper(
+            sensorplan.queryhelp,
+        )
+        self.tuple = async_to_streamed_response_wrapper(
+            sensorplan.tuple,
+        )
+        self.unvalidated_publish = async_to_streamed_response_wrapper(
+            sensorplan.unvalidated_publish,
+        )
+
+    @cached_property
+    def history(self) -> AsyncHistoryResourceWithStreamingResponse:
+        return AsyncHistoryResourceWithStreamingResponse(self._sensorplan.history)