nominal-api 0.965.0__py3-none-any.whl → 0.966.0__py3-none-any.whl

nominal_api/__init__.py

@@ -82,5 +82,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.965.0"
+__version__ = "0.966.0"
 

nominal_api/_impl.py

@@ -5898,6 +5898,153 @@ datasource_pagination_api_PageResponse.__qualname__ = "PageResponse"
 datasource_pagination_api_PageResponse.__module__ = "nominal_api.datasource_pagination_api"
 
 
+class event_AggregateEventsRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'query': ConjureFieldDefinition('query', event_SearchQuery),
+            'aggregate_types': ConjureFieldDefinition('aggregateTypes', List[event_AggregateType])
+        }
+
+    __slots__: List[str] = ['_query', '_aggregate_types']
+
+    def __init__(self, aggregate_types: List["event_AggregateType"], query: "event_SearchQuery") -> None:
+        self._query = query
+        self._aggregate_types = aggregate_types
+
+    @builtins.property
+    def query(self) -> "event_SearchQuery":
+        return self._query
+
+    @builtins.property
+    def aggregate_types(self) -> List["event_AggregateType"]:
+        return self._aggregate_types
+
+
+event_AggregateEventsRequest.__name__ = "AggregateEventsRequest"
+event_AggregateEventsRequest.__qualname__ = "AggregateEventsRequest"
+event_AggregateEventsRequest.__module__ = "nominal_api.event"
+
+
+class event_AggregateEventsResponse(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'values': ConjureFieldDefinition('values', Dict[event_AggregateType, event_AggregateValue])
+        }
+
+    __slots__: List[str] = ['_values']
+
+    def __init__(self, values: Dict["event_AggregateType", "event_AggregateValue"]) -> None:
+        self._values = values
+
+    @builtins.property
+    def values(self) -> Dict["event_AggregateType", "event_AggregateValue"]:
+        return self._values
+
+
+event_AggregateEventsResponse.__name__ = "AggregateEventsResponse"
+event_AggregateEventsResponse.__qualname__ = "AggregateEventsResponse"
+event_AggregateEventsResponse.__module__ = "nominal_api.event"
+
+
+class event_AggregateType(ConjureEnumType):
+
+    TOTAL_DURATION = 'TOTAL_DURATION'
+    '''TOTAL_DURATION'''
+    TOTAL_COUNT = 'TOTAL_COUNT'
+    '''TOTAL_COUNT'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+event_AggregateType.__name__ = "AggregateType"
+event_AggregateType.__qualname__ = "AggregateType"
+event_AggregateType.__module__ = "nominal_api.event"
+
+
+class event_AggregateValue(ConjureUnionType):
+    _duration: Optional["scout_run_api_Duration"] = None
+    _count: Optional[int] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'duration': ConjureFieldDefinition('duration', scout_run_api_Duration),
+            'count': ConjureFieldDefinition('count', int)
+        }
+
+    def __init__(
+            self,
+            duration: Optional["scout_run_api_Duration"] = None,
+            count: Optional[int] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (duration is not None) + (count is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if duration is not None:
+                self._duration = duration
+                self._type = 'duration'
+            if count is not None:
+                self._count = count
+                self._type = 'count'
+
+        elif type_of_union == 'duration':
+            if duration is None:
+                raise ValueError('a union value must not be None')
+            self._duration = duration
+            self._type = 'duration'
+        elif type_of_union == 'count':
+            if count is None:
+                raise ValueError('a union value must not be None')
+            self._count = count
+            self._type = 'count'
+
+    @builtins.property
+    def duration(self) -> Optional["scout_run_api_Duration"]:
+        return self._duration
+
+    @builtins.property
+    def count(self) -> Optional[int]:
+        return self._count
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, event_AggregateValueVisitor):
+            raise ValueError('{} is not an instance of event_AggregateValueVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'duration' and self.duration is not None:
+            return visitor._duration(self.duration)
+        if self._type == 'count' and self.count is not None:
+            return visitor._count(self.count)
+
+
+event_AggregateValue.__name__ = "AggregateValue"
+event_AggregateValue.__qualname__ = "AggregateValue"
+event_AggregateValue.__module__ = "nominal_api.event"
+
+
+class event_AggregateValueVisitor:
+
+    @abstractmethod
+    def _duration(self, duration: "scout_run_api_Duration") -> Any:
+        pass
+
+    @abstractmethod
+    def _count(self, count: int) -> Any:
+        pass
+
+
+event_AggregateValueVisitor.__name__ = "AggregateValueVisitor"
+event_AggregateValueVisitor.__qualname__ = "AggregateValueVisitor"
+event_AggregateValueVisitor.__module__ = "nominal_api.event"
+
+
 class event_ApiEventOrigin(ConjureBeanType):
 
     @builtins.classmethod
@@ -6859,6 +7006,38 @@ Empty fields in the UpdateEventRequest are left unchanged.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), event_SearchEventsResponse, self._return_none_for_unknown_union_types)
 
+    def aggregate_events(self, auth_header: str, request: "event_AggregateEventsRequest") -> "event_AggregateEventsResponse":
+        """Searches for events matching the given filter and aggregates them based on the requested functions.
+        """
+        _conjure_encoder = ConjureEncoder()
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, str] = {
+        }
+
+        _json: Any = _conjure_encoder.default(request)
+
+        _path = '/event/v1/aggregate-events'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), event_AggregateEventsResponse, self._return_none_for_unknown_union_types)
+
     def get_events_histogram(self, auth_header: str, request: "event_EventsHistogramRequest") -> "event_EventsHistogramResponse":
         """Gets a histogram of events that match the given filters.
         """
@@ -79531,6 +79710,8 @@ class scout_run_api_CreateRunRequest(ConjureBeanType):
 
     @builtins.property
     def title(self) -> str:
+        """This must be non-empty.
+        """
         return self._title
 
     @builtins.property
@@ -79563,6 +79744,9 @@ class scout_run_api_CreateRunRequest(ConjureBeanType):
 
     @builtins.property
     def data_sources(self) -> Dict[str, "scout_run_api_CreateRunDataSource"]:
+        """The data sources to include in this run. If asset or assets is provided, this field
+will be ignored. Exactly one of data source(s) or asset(s) must be provided for a run.
+        """
         return self._data_sources
 
     @builtins.property
@@ -79575,6 +79759,10 @@ class scout_run_api_CreateRunRequest(ConjureBeanType):
 
     @builtins.property
     def assets(self) -> List[str]:
+        """The assets to associate with the run. If this is specified, the deprecated asset field
+is ignored and least one asset must be specified. Exactly one of data source(s) or asset(s)
+must be provided for a run.
+        """
         return self._assets
 
     @builtins.property
@@ -81686,12 +81874,12 @@ class scout_run_api_UpdateRunRequest(ConjureBeanType):
             'data_sources': ConjureFieldDefinition('dataSources', OptionalTypeWrapper[Dict[scout_api_DataSourceRefName, scout_run_api_CreateRunDataSource]]),
             'attachments': ConjureFieldDefinition('attachments', OptionalTypeWrapper[List[api_rids_AttachmentRid]]),
             'asset': ConjureFieldDefinition('asset', OptionalTypeWrapper[scout_rids_api_AssetRid]),
-            'assets': ConjureFieldDefinition('assets', List[scout_rids_api_AssetRid])
+            'assets': ConjureFieldDefinition('assets', OptionalTypeWrapper[List[scout_rids_api_AssetRid]])
         }
 
     __slots__: List[str] = ['_title', '_description', '_start_time', '_end_time', '_properties', '_labels', '_links', '_run_prefix', '_data_sources', '_attachments', '_asset', '_assets']
 
-    def __init__(self, assets: List[str], asset: Optional[str] = None, attachments: Optional[List[str]] = None, data_sources: Optional[Dict[str, "scout_run_api_CreateRunDataSource"]] = None, description: Optional[str] = None, end_time: Optional["scout_run_api_UtcTimestamp"] = None, labels: Optional[List[str]] = None, links: Optional[List["scout_run_api_Link"]] = None, properties: Optional[Dict[str, str]] = None, run_prefix: Optional[str] = None, start_time: Optional["scout_run_api_UtcTimestamp"] = None, title: Optional[str] = None) -> None:
+    def __init__(self, asset: Optional[str] = None, assets: Optional[List[str]] = None, attachments: Optional[List[str]] = None, data_sources: Optional[Dict[str, "scout_run_api_CreateRunDataSource"]] = None, description: Optional[str] = None, end_time: Optional["scout_run_api_UtcTimestamp"] = None, labels: Optional[List[str]] = None, links: Optional[List["scout_run_api_Link"]] = None, properties: Optional[Dict[str, str]] = None, run_prefix: Optional[str] = None, start_time: Optional["scout_run_api_UtcTimestamp"] = None, title: Optional[str] = None) -> None:
         self._title = title
         self._description = description
         self._start_time = start_time
@@ -81741,6 +81929,9 @@ class scout_run_api_UpdateRunRequest(ConjureBeanType):
 
     @builtins.property
     def data_sources(self) -> Optional[Dict[str, "scout_run_api_CreateRunDataSource"]]:
+        """The data sources to include in this run. If asset or assets is provided, this field
+will be ignored. Exactly one of data source(s) or asset(s) must be provided for a run.
+        """
         return self._data_sources
 
     @builtins.property
@@ -81752,7 +81943,11 @@ class scout_run_api_UpdateRunRequest(ConjureBeanType):
         return self._asset
 
     @builtins.property
-    def assets(self) -> List[str]:
+    def assets(self) -> Optional[List[str]]:
+        """The assets to associate with the run. If this is specified, the deprecated asset field
+is ignored and at least one asset must be specified. Exactly one of data source(s) or
+asset(s) must be provided for a run.
+        """
         return self._assets
 
 
@@ -86048,8 +86243,9 @@ Enforces write permission on the video.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), scout_video_api_GenerateWhipStreamResponse, self._return_none_for_unknown_union_types)
 
-    def generate_whep_stream(self, auth_header: str, stream_id: str, video_rid: str) -> "scout_video_api_GenerateWhepStreamResponse":
-        """Returns WHEP URL, ICE servers, and token for playing back a stream.
+    def generate_whep_stream(self, auth_header: str, video_rid: str) -> Optional["scout_video_api_GenerateWhepStreamResponse"]:
+        """Returns WHEP URL, ICE servers, and token for playing back the active stream.
+Returns empty if there is no active stream.
 Enforces read permission on the video.
         """
         _conjure_encoder = ConjureEncoder()
@@ -86064,12 +86260,11 @@ Enforces read permission on the video.
 
         _path_params: Dict[str, str] = {
             'videoRid': quote(str(_conjure_encoder.default(video_rid)), safe=''),
-            'streamId': quote(str(_conjure_encoder.default(stream_id)), safe=''),
         }
 
         _json: Any = None
 
-        _path = '/video/v1/videos/{videoRid}/streaming/whep/{streamId}'
+        _path = '/video/v1/videos/{videoRid}/streaming/whep'
         _path = _path.format(**_path_params)
 
         _response: Response = self._request(
@@ -86080,7 +86275,7 @@ Enforces read permission on the video.
             json=_json)
 
         _decoder = ConjureDecoder()
-        return _decoder.decode(_response.json(), scout_video_api_GenerateWhepStreamResponse, self._return_none_for_unknown_union_types)
+        return None if _response.status_code == 204 else _decoder.decode(_response.json(), OptionalTypeWrapper[scout_video_api_GenerateWhepStreamResponse], self._return_none_for_unknown_union_types)
 
 
 scout_video_VideoService.__name__ = "VideoService"

nominal_api/event/__init__.py

@@ -1,5 +1,10 @@
 # coding=utf-8
 from .._impl import (
+    event_AggregateEventsRequest as AggregateEventsRequest,
+    event_AggregateEventsResponse as AggregateEventsResponse,
+    event_AggregateType as AggregateType,
+    event_AggregateValue as AggregateValue,
+    event_AggregateValueVisitor as AggregateValueVisitor,
     event_ApiEventOrigin as ApiEventOrigin,
     event_ArchiveEvent as ArchiveEvent,
     event_AssetsFilter as AssetsFilter,
@@ -45,6 +50,11 @@ from .._impl import (
 )
 
 __all__ = [
+    'AggregateEventsRequest',
+    'AggregateEventsResponse',
+    'AggregateType',
+    'AggregateValue',
+    'AggregateValueVisitor',
     'ApiEventOrigin',
     'ArchiveEvent',
     'AssetsFilter',

{nominal_api-0.965.0.dist-info → nominal_api-0.966.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal-api
-Version: 0.965.0
+Version: 0.966.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<4,>=2.8.0

{nominal_api-0.965.0.dist-info → nominal_api-0.966.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=L9Uu6SE4RqjQ2zC6G-rnvkz3AqADVKQfuf9topO3-Vw,2109
-nominal_api/_impl.py,sha256=McnuO15d0wWI-NAiq0zPNXR-8yKxZgDVvTfKupmUSHs,3841873
+nominal_api/__init__.py,sha256=PhQ7l9tYy8uI14LZYpFfXeXTaZPqMUPQJiU6c3Fzxsg,2109
+nominal_api/_impl.py,sha256=ThUPvJocnSu8U9NONnXkpHOUcZz7l0YMZ0rmYxwhtN8,3848748
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=OHAEgaRoUX60742H_U3q_pBoPGpLspsL5XERHQ-rjMs,2299
 nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -14,7 +14,7 @@ nominal_api/datasource_api/__init__.py,sha256=75g1qHgKGFMR87uXPvyowgKuLua62v3NPT
 nominal_api/datasource_logset/__init__.py,sha256=SGt5PmLgYpLfhcoESk69aVufuZugg8dp6XBHOZ480IA,130
 nominal_api/datasource_logset_api/__init__.py,sha256=QydoWxNXCVgIV8HWnZAKA77N5G6mTSqSzGkj36tPe4U,1376
 nominal_api/datasource_pagination_api/__init__.py,sha256=WeENj6yqi2XfInU8YgjFwqwiR8L0jDHCBZfucJ0ahyY,283
-nominal_api/event/__init__.py,sha256=lWZZzsEOmtmPNNU9_kYMj1uTgoyc2QL8slsD8UeHWNM,3403
+nominal_api/event/__init__.py,sha256=AwX_cxCrb9CqM7qYHkE2t7qCwYU5dObuo6whHiNHJMw,3802
 nominal_api/ingest_api/__init__.py,sha256=OZ1xKwsMx_IeFKrVnwYky9sWMymeYrEAHW62cVE_tqo,11156
 nominal_api/ingest_manifest/__init__.py,sha256=HvXQUiDc886ITCkoR7OEXopRIFE9Z7dFNE8_FViNP0s,483
 nominal_api/ingest_workflow_api/__init__.py,sha256=UdkTnAnXSs1Q17GfWOK6iJbqu7NecX0VP2Jkwj1Pj_k,3159
@@ -79,7 +79,7 @@ nominal_api/timeseries_seriescache/__init__.py,sha256=hL5hN8jKLEGE_fDiZzdASmWIrR
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=i21vITWBn-6ruVuFZg491TDpx6WcIhJBoF3oNw3w338,1186
 nominal_api/upload_api/__init__.py,sha256=7-XXuZUqKPV4AMWvxNpZPZ5vBun4x-AomXj3Vol_BN4,123
 nominal_api/usercreation_api/__init__.py,sha256=Q6M70SlKFVfIxZqRohD4XYmBz5t2DP1DB0a0Q6glqGA,171
-nominal_api-0.965.0.dist-info/METADATA,sha256=9FcqmpMxvaEuxsIJH9g_HqXCrCYKiT-J6UjoyU8e4yg,199
-nominal_api-0.965.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nominal_api-0.965.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.965.0.dist-info/RECORD,,
+nominal_api-0.966.0.dist-info/METADATA,sha256=9TveJMU3t8-fuuv91EwpdOAMLyvdcklFBX9fjgAr6aY,199
+nominal_api-0.966.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nominal_api-0.966.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.966.0.dist-info/RECORD,,