nominal-api 0.626.0__tar.gz → 0.627.0__tar.gz

{nominal_api-0.626.0 → nominal_api-0.627.0}/PKG-INFO

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

{nominal_api-0.626.0 → nominal_api-0.627.0}/nominal_api/__init__.py

@@ -76,5 +76,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.626.0"
+__version__ = "0.627.0"
 

{nominal_api-0.626.0 → nominal_api-0.627.0}/nominal_api/_impl.py

@@ -5637,7 +5637,8 @@ class event_Event(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'uuid': ConjureFieldDefinition('uuid', str),
+            'uuid': ConjureFieldDefinition('uuid', OptionalTypeWrapper[str]),
+            'rid': ConjureFieldDefinition('rid', api_rids_EventRid),
             'asset_rids': ConjureFieldDefinition('assetRids', List[scout_rids_api_AssetRid]),
             'origins': ConjureFieldDefinition('origins', List[event_EventOrigin]),
             'timestamp': ConjureFieldDefinition('timestamp', api_Timestamp),
@@ -5651,10 +5652,11 @@ class event_Event(ConjureBeanType):
             'created_by': ConjureFieldDefinition('createdBy', OptionalTypeWrapper[scout_rids_api_UserRid])
         }
 
-    __slots__: List[str] = ['_uuid', '_asset_rids', '_origins', '_timestamp', '_duration', '_name', '_description', '_type', '_labels', '_properties', '_is_archived', '_created_by']
+    __slots__: List[str] = ['_uuid', '_rid', '_asset_rids', '_origins', '_timestamp', '_duration', '_name', '_description', '_type', '_labels', '_properties', '_is_archived', '_created_by']
 
-    def __init__(self, asset_rids: List[str], description: str, duration: "scout_run_api_Duration", is_archived: bool, labels: List[str], name: str, origins: List["event_EventOrigin"], properties: Dict[str, str], timestamp: "api_Timestamp", type: "event_EventType", uuid: str, created_by: Optional[str] = None) -> None:
+    def __init__(self, asset_rids: List[str], description: str, duration: "scout_run_api_Duration", is_archived: bool, labels: List[str], name: str, origins: List["event_EventOrigin"], properties: Dict[str, str], rid: str, timestamp: "api_Timestamp", type: "event_EventType", created_by: Optional[str] = None, uuid: Optional[str] = None) -> None:
         self._uuid = uuid
+        self._rid = rid
         self._asset_rids = asset_rids
         self._origins = origins
         self._timestamp = timestamp
@@ -5668,14 +5670,13 @@ class event_Event(ConjureBeanType):
         self._created_by = created_by
 
     @builtins.property
-    def uuid(self) -> str:
-        """
-        The unique identifier for the event. Events are identified by their UUID, rather than RID, because 
-events are not directly authorized resources, but are instead authorized indirectly through their 
-associated assets. Thus an event RID would not identify a valid authorized resource.
-        """
+    def uuid(self) -> Optional[str]:
         return self._uuid
 
+    @builtins.property
+    def rid(self) -> str:
+        return self._rid
+
     @builtins.property
     def asset_rids(self) -> List[str]:
         """
@@ -5914,9 +5915,42 @@ The Event Service is responsible for creating and retrieving events for a partic
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), List[event_Event], self._return_none_for_unknown_union_types)
 
+    def batch_get_events(self, auth_header: str, request: List[str] = None) -> List["event_Event"]:
+        """
+        Gets a set of events by RID.
+        """
+        request = request if request is not None else []
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/event/v1/events/batch-get'
+        _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(), List[event_Event], self._return_none_for_unknown_union_types)
+
     def update_event(self, auth_header: str, request: "event_UpdateEvent") -> "event_Event":
         """
-        Updates the fields of an event. Empty fields are left unchanged
+        Updates the fields of an event. Empty fields are left unchanged.
         """
 
         _headers: Dict[str, Any] = {
@@ -5977,6 +6011,38 @@ The Event Service is responsible for creating and retrieving events for a partic
 
         return
 
+    def batch_archive_event(self, auth_header: str, request: List[str] = None) -> None:
+        """
+        Archives a set of events
+        """
+        request = request if request is not None else []
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/event/v1/batch-archive-events'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        return
+
     def search_events(self, auth_header: str, request: "event_SearchEventsRequest") -> "event_SearchEventsResponse":
         """
         Searches for events that match the given filters.
@@ -6445,7 +6511,8 @@ class event_UpdateEvent(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'uuid': ConjureFieldDefinition('uuid', str),
+            'uuid': ConjureFieldDefinition('uuid', OptionalTypeWrapper[str]),
+            'rid': ConjureFieldDefinition('rid', OptionalTypeWrapper[api_rids_EventRid]),
             'asset_rids': ConjureFieldDefinition('assetRids', OptionalTypeWrapper[List[scout_rids_api_AssetRid]]),
             'timestamp': ConjureFieldDefinition('timestamp', OptionalTypeWrapper[api_Timestamp]),
             'duration': ConjureFieldDefinition('duration', OptionalTypeWrapper[scout_run_api_Duration]),
@@ -6456,10 +6523,11 @@ class event_UpdateEvent(ConjureBeanType):
             'properties': ConjureFieldDefinition('properties', OptionalTypeWrapper[Dict[api_PropertyName, api_PropertyValue]])
         }
 
-    __slots__: List[str] = ['_uuid', '_asset_rids', '_timestamp', '_duration', '_name', '_description', '_type', '_labels', '_properties']
+    __slots__: List[str] = ['_uuid', '_rid', '_asset_rids', '_timestamp', '_duration', '_name', '_description', '_type', '_labels', '_properties']
 
-    def __init__(self, uuid: str, asset_rids: Optional[List[str]] = None, description: Optional[str] = None, duration: Optional["scout_run_api_Duration"] = None, labels: Optional[List[str]] = None, name: Optional[str] = None, properties: Optional[Dict[str, str]] = None, timestamp: Optional["api_Timestamp"] = None, type: Optional["event_EventType"] = None) -> None:
+    def __init__(self, asset_rids: Optional[List[str]] = None, description: Optional[str] = None, duration: Optional["scout_run_api_Duration"] = None, labels: Optional[List[str]] = None, name: Optional[str] = None, properties: Optional[Dict[str, str]] = None, rid: Optional[str] = None, timestamp: Optional["api_Timestamp"] = None, type: Optional["event_EventType"] = None, uuid: Optional[str] = None) -> None:
         self._uuid = uuid
+        self._rid = rid
         self._asset_rids = asset_rids
         self._timestamp = timestamp
         self._duration = duration
@@ -6470,9 +6538,17 @@ class event_UpdateEvent(ConjureBeanType):
         self._properties = properties
 
     @builtins.property
-    def uuid(self) -> str:
+    def uuid(self) -> Optional[str]:
         return self._uuid
 
+    @builtins.property
+    def rid(self) -> Optional[str]:
+        """
+        The unique identifier for the event.
+This field is required if the uuid field is not provided.
+        """
+        return self._rid
+
     @builtins.property
     def asset_rids(self) -> Optional[List[str]]:
         """
@@ -21957,6 +22033,38 @@ scout_chartdefinition_api_LineThresholdGroup.__qualname__ = "LineThresholdGroup"
 scout_chartdefinition_api_LineThresholdGroup.__module__ = "nominal_api.scout_chartdefinition_api"
 
 
+class scout_chartdefinition_api_LogChannel(ConjureBeanType):
+    """
+    A field to save additional column names on log panels with support for multiple variables
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'log_channel_variable_name': ConjureFieldDefinition('logChannelVariableName', scout_channelvariables_api_ChannelVariableName),
+            'visible_log_column_names': ConjureFieldDefinition('visibleLogColumnNames', List[scout_chartdefinition_api_LogColumnName])
+        }
+
+    __slots__: List[str] = ['_log_channel_variable_name', '_visible_log_column_names']
+
+    def __init__(self, log_channel_variable_name: str, visible_log_column_names: List[str]) -> None:
+        self._log_channel_variable_name = log_channel_variable_name
+        self._visible_log_column_names = visible_log_column_names
+
+    @builtins.property
+    def log_channel_variable_name(self) -> str:
+        return self._log_channel_variable_name
+
+    @builtins.property
+    def visible_log_column_names(self) -> List[str]:
+        return self._visible_log_column_names
+
+
+scout_chartdefinition_api_LogChannel.__name__ = "LogChannel"
+scout_chartdefinition_api_LogChannel.__qualname__ = "LogChannel"
+scout_chartdefinition_api_LogChannel.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
 class scout_chartdefinition_api_LogPanelDefinition(ConjureUnionType):
     _v1: Optional["scout_chartdefinition_api_LogPanelDefinitionV1"] = None
 
@@ -22019,14 +22127,16 @@ class scout_chartdefinition_api_LogPanelDefinitionV1(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
-            'log_channels': ConjureFieldDefinition('logChannels', List[scout_channelvariables_api_ChannelVariableName])
+            'log_channels': ConjureFieldDefinition('logChannels', List[scout_channelvariables_api_ChannelVariableName]),
+            'log_channels_v2': ConjureFieldDefinition('logChannelsV2', OptionalTypeWrapper[List[scout_chartdefinition_api_LogChannel]])
         }
 
-    __slots__: List[str] = ['_title', '_log_channels']
+    __slots__: List[str] = ['_title', '_log_channels', '_log_channels_v2']
 
-    def __init__(self, log_channels: List[str], title: Optional[str] = None) -> None:
+    def __init__(self, log_channels: List[str], log_channels_v2: Optional[List["scout_chartdefinition_api_LogChannel"]] = None, title: Optional[str] = None) -> None:
         self._title = title
         self._log_channels = log_channels
+        self._log_channels_v2 = log_channels_v2
 
     @builtins.property
     def title(self) -> Optional[str]:
@@ -22036,6 +22146,10 @@ class scout_chartdefinition_api_LogPanelDefinitionV1(ConjureBeanType):
     def log_channels(self) -> List[str]:
         return self._log_channels
 
+    @builtins.property
+    def log_channels_v2(self) -> Optional[List["scout_chartdefinition_api_LogChannel"]]:
+        return self._log_channels_v2
+
 
 scout_chartdefinition_api_LogPanelDefinitionV1.__name__ = "LogPanelDefinitionV1"
 scout_chartdefinition_api_LogPanelDefinitionV1.__qualname__ = "LogPanelDefinitionV1"
@@ -77409,8 +77523,6 @@ scout_units_api_UnitProperty = str
 
 timeseries_logicalseries_api_MeasurementName = str
 
-event_EventRid = str
-
 themes_api_HexColor = str
 
 scout_compute_representation_api_ComputeExpression = str
@@ -77483,6 +77595,8 @@ storage_writer_api_MeasurementName = str
 
 storage_datasource_api_NominalDataSourceId = str
 
+api_rids_EventRid = str
+
 persistent_compute_api_Milliseconds = int
 
 scout_datareview_api_AutomaticCheckEvaluationRid = str
@@ -77531,6 +77645,8 @@ scout_rids_api_ApiKeyRid = str
 
 ingest_api_ChannelPrefix = OptionalTypeWrapper[str]
 
+scout_chartdefinition_api_LogColumnName = str
+
 scout_rids_api_AssetRid = str
 
 comments_api_CommentRid = str

{nominal_api-0.626.0 → nominal_api-0.627.0}/nominal_api/api_rids/__init__.py

@@ -4,6 +4,7 @@ from .._impl import (
     api_rids_ChunkRid as ChunkRid,
     api_rids_DataSourceRid as DataSourceRid,
     api_rids_DatasetRid as DatasetRid,
+    api_rids_EventRid as EventRid,
     api_rids_NominalDataSourceOrDatasetRid as NominalDataSourceOrDatasetRid,
     api_rids_NominalDataSourceRid as NominalDataSourceRid,
     api_rids_SegmentRid as SegmentRid,

{nominal_api-0.626.0 → nominal_api-0.627.0}/nominal_api/event/__init__.py

@@ -6,7 +6,6 @@ from .._impl import (
     event_Event as Event,
     event_EventOrigin as EventOrigin,
     event_EventOriginVisitor as EventOriginVisitor,
-    event_EventRid as EventRid,
     event_EventService as EventService,
     event_EventType as EventType,
     event_GetEvents as GetEvents,

{nominal_api-0.626.0 → nominal_api-0.627.0}/nominal_api/scout_chartdefinition_api/__init__.py

@@ -61,6 +61,8 @@ from .._impl import (
     scout_chartdefinition_api_LineStyleVisitor as LineStyleVisitor,
     scout_chartdefinition_api_LineThreshold as LineThreshold,
     scout_chartdefinition_api_LineThresholdGroup as LineThresholdGroup,
+    scout_chartdefinition_api_LogChannel as LogChannel,
+    scout_chartdefinition_api_LogColumnName as LogColumnName,
     scout_chartdefinition_api_LogPanelDefinition as LogPanelDefinition,
     scout_chartdefinition_api_LogPanelDefinitionV1 as LogPanelDefinitionV1,
     scout_chartdefinition_api_LogPanelDefinitionVisitor as LogPanelDefinitionVisitor,

{nominal_api-0.626.0 → nominal_api-0.627.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.626.0 → nominal_api-0.627.0}/setup.py

@@ -6,7 +6,7 @@ from setuptools import (
 
 setup(
     name='nominal-api',
-    version='0.626.0',
+    version='0.627.0',
     python_requires='>=3.8',
     package_data={"": ["py.typed"]},
     packages=find_packages(),