nominal-api 0.926.0__py3-none-any.whl → 0.928.0__py3-none-any.whl

nominal_api/__init__.py

@@ -81,5 +81,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.926.0"
+__version__ = "0.928.0"
 

nominal_api/_impl.py

@@ -7975,6 +7975,39 @@ event_TemplateEventOrigin.__qualname__ = "TemplateEventOrigin"
 event_TemplateEventOrigin.__module__ = "nominal_api.event"
 
 
+class event_TimeSeriesChannelAssociation(ConjureBeanType):
+    """A singular time series to associate the event with.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'variable_name': ConjureFieldDefinition('variableName', str),
+            'tags': ConjureFieldDefinition('tags', OptionalTypeWrapper[Dict[str, str]])
+        }
+
+    __slots__: List[str] = ['_variable_name', '_tags']
+
+    def __init__(self, variable_name: str, tags: Optional[Dict[str, str]] = None) -> None:
+        self._variable_name = variable_name
+        self._tags = tags
+
+    @builtins.property
+    def variable_name(self) -> str:
+        return self._variable_name
+
+    @builtins.property
+    def tags(self) -> Optional[Dict[str, str]]:
+        """If this variable is grouped, the tags within the groupings this event should associate with
+        """
+        return self._tags
+
+
+event_TimeSeriesChannelAssociation.__name__ = "TimeSeriesChannelAssociation"
+event_TimeSeriesChannelAssociation.__qualname__ = "TimeSeriesChannelAssociation"
+event_TimeSeriesChannelAssociation.__module__ = "nominal_api.event"
+
+
 class event_UpdateDispositionRequest(ConjureBeanType):
 
     @builtins.classmethod
@@ -8164,23 +8197,87 @@ event_UpdateEventRequest.__qualname__ = "UpdateEventRequest"
 event_UpdateEventRequest.__module__ = "nominal_api.event"
 
 
+class event_WorkbookDataAssociation(ConjureUnionType):
+    _time_series_channel: Optional["event_TimeSeriesChannelAssociation"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'time_series_channel': ConjureFieldDefinition('timeSeriesChannel', event_TimeSeriesChannelAssociation)
+        }
+
+    def __init__(
+            self,
+            time_series_channel: Optional["event_TimeSeriesChannelAssociation"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (time_series_channel is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if time_series_channel is not None:
+                self._time_series_channel = time_series_channel
+                self._type = 'timeSeriesChannel'
+
+        elif type_of_union == 'timeSeriesChannel':
+            if time_series_channel is None:
+                raise ValueError('a union value must not be None')
+            self._time_series_channel = time_series_channel
+            self._type = 'timeSeriesChannel'
+
+    @builtins.property
+    def time_series_channel(self) -> Optional["event_TimeSeriesChannelAssociation"]:
+        return self._time_series_channel
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, event_WorkbookDataAssociationVisitor):
+            raise ValueError('{} is not an instance of event_WorkbookDataAssociationVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'timeSeriesChannel' and self.time_series_channel is not None:
+            return visitor._time_series_channel(self.time_series_channel)
+
+
+event_WorkbookDataAssociation.__name__ = "WorkbookDataAssociation"
+event_WorkbookDataAssociation.__qualname__ = "WorkbookDataAssociation"
+event_WorkbookDataAssociation.__module__ = "nominal_api.event"
+
+
+class event_WorkbookDataAssociationVisitor:
+
+    @abstractmethod
+    def _time_series_channel(self, time_series_channel: "event_TimeSeriesChannelAssociation") -> Any:
+        pass
+
+
+event_WorkbookDataAssociationVisitor.__name__ = "WorkbookDataAssociationVisitor"
+event_WorkbookDataAssociationVisitor.__qualname__ = "WorkbookDataAssociationVisitor"
+event_WorkbookDataAssociationVisitor.__module__ = "nominal_api.event"
+
+
 class event_WorkbookEventOrigin(ConjureBeanType):
 
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'rid': ConjureFieldDefinition('rid', scout_rids_api_NotebookRid)
+            'rid': ConjureFieldDefinition('rid', scout_rids_api_NotebookRid),
+            'data': ConjureFieldDefinition('data', OptionalTypeWrapper[event_WorkbookDataAssociation])
         }
 
-    __slots__: List[str] = ['_rid']
+    __slots__: List[str] = ['_rid', '_data']
 
-    def __init__(self, rid: str) -> None:
+    def __init__(self, rid: str, data: Optional["event_WorkbookDataAssociation"] = None) -> None:
         self._rid = rid
+        self._data = data
 
     @builtins.property
     def rid(self) -> str:
         return self._rid
 
+    @builtins.property
+    def data(self) -> Optional["event_WorkbookDataAssociation"]:
+        """A data visualization to associate this event with
+        """
+        return self._data
+
 
 event_WorkbookEventOrigin.__name__ = "WorkbookEventOrigin"
 event_WorkbookEventOrigin.__qualname__ = "WorkbookEventOrigin"
@@ -87758,6 +87855,35 @@ scout_workbookcommon_api_InputTypeVisitor.__qualname__ = "InputTypeVisitor"
 scout_workbookcommon_api_InputTypeVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
 
 
+class scout_workbookcommon_api_RunSettings(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'offset': ConjureFieldDefinition('offset', OptionalTypeWrapper[scout_rids_api_UserDuration]),
+            'asset_settings': ConjureFieldDefinition('assetSettings', OptionalTypeWrapper[Dict[scout_rids_api_AssetRid, scout_workbookcommon_api_AssetSettings]])
+        }
+
+    __slots__: List[str] = ['_offset', '_asset_settings']
+
+    def __init__(self, asset_settings: Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]] = None, offset: Optional["scout_rids_api_UserDuration"] = None) -> None:
+        self._offset = offset
+        self._asset_settings = asset_settings
+
+    @builtins.property
+    def offset(self) -> Optional["scout_rids_api_UserDuration"]:
+        return self._offset
+
+    @builtins.property
+    def asset_settings(self) -> Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]]:
+        return self._asset_settings
+
+
+scout_workbookcommon_api_RunSettings.__name__ = "RunSettings"
+scout_workbookcommon_api_RunSettings.__qualname__ = "RunSettings"
+scout_workbookcommon_api_RunSettings.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
 class scout_workbookcommon_api_Tag(ConjureBeanType):
     """A tag input contains tag key and tag value information that can apply
 to a channel's compute tree. Applies the tag to both the tag filter
@@ -88137,18 +88263,28 @@ class scout_workbookcommon_api_WorkbookSettings(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'asset_settings': ConjureFieldDefinition('assetSettings', Dict[scout_rids_api_AssetRid, scout_workbookcommon_api_AssetSettings])
+            'asset_settings': ConjureFieldDefinition('assetSettings', OptionalTypeWrapper[Dict[scout_rids_api_AssetRid, scout_workbookcommon_api_AssetSettings]]),
+            'run_settings': ConjureFieldDefinition('runSettings', OptionalTypeWrapper[Dict[scout_run_api_RunRid, scout_workbookcommon_api_RunSettings]])
         }
 
-    __slots__: List[str] = ['_asset_settings']
+    __slots__: List[str] = ['_asset_settings', '_run_settings']
 
-    def __init__(self, asset_settings: Dict[str, "scout_workbookcommon_api_AssetSettings"]) -> None:
+    def __init__(self, asset_settings: Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]] = None, run_settings: Optional[Dict[str, "scout_workbookcommon_api_RunSettings"]] = None) -> None:
         self._asset_settings = asset_settings
+        self._run_settings = run_settings
 
     @builtins.property
-    def asset_settings(self) -> Dict[str, "scout_workbookcommon_api_AssetSettings"]:
+    def asset_settings(self) -> Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]]:
+        """Settings for assets to be used in the workbook. This should be present for asset workbooks.
+        """
         return self._asset_settings
 
+    @builtins.property
+    def run_settings(self) -> Optional[Dict[str, "scout_workbookcommon_api_RunSettings"]]:
+        """Settings for runs to be used in the workbook. This should be present for run workbooks.
+        """
+        return self._run_settings
+
 
 scout_workbookcommon_api_WorkbookSettings.__name__ = "WorkbookSettings"
 scout_workbookcommon_api_WorkbookSettings.__qualname__ = "WorkbookSettings"

nominal_api/event/__init__.py

@@ -34,9 +34,12 @@ from .._impl import (
     event_SortField as SortField,
     event_SortOptions as SortOptions,
     event_TemplateEventOrigin as TemplateEventOrigin,
+    event_TimeSeriesChannelAssociation as TimeSeriesChannelAssociation,
     event_UpdateDispositionRequest as UpdateDispositionRequest,
     event_UpdateEvent as UpdateEvent,
     event_UpdateEventRequest as UpdateEventRequest,
+    event_WorkbookDataAssociation as WorkbookDataAssociation,
+    event_WorkbookDataAssociationVisitor as WorkbookDataAssociationVisitor,
     event_WorkbookEventOrigin as WorkbookEventOrigin,
 )
 
@@ -74,9 +77,12 @@ __all__ = [
     'SortField',
     'SortOptions',
     'TemplateEventOrigin',
+    'TimeSeriesChannelAssociation',
     'UpdateDispositionRequest',
     'UpdateEvent',
     'UpdateEventRequest',
+    'WorkbookDataAssociation',
+    'WorkbookDataAssociationVisitor',
     'WorkbookEventOrigin',
     'EventService',
 ]

nominal_api/scout_workbookcommon_api/__init__.py

@@ -5,6 +5,7 @@ from .._impl import (
     scout_workbookcommon_api_EventReference as EventReference,
     scout_workbookcommon_api_InputType as InputType,
     scout_workbookcommon_api_InputTypeVisitor as InputTypeVisitor,
+    scout_workbookcommon_api_RunSettings as RunSettings,
     scout_workbookcommon_api_Tag as Tag,
     scout_workbookcommon_api_TagString as TagString,
     scout_workbookcommon_api_TagStringLiteral as TagStringLiteral,
@@ -25,6 +26,7 @@ __all__ = [
     'EventReference',
     'InputType',
     'InputTypeVisitor',
+    'RunSettings',
     'Tag',
     'TagString',
     'TagStringVisitor',

{nominal_api-0.926.0.dist-info → nominal_api-0.928.0.dist-info}/METADATA

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

{nominal_api-0.926.0.dist-info → nominal_api-0.928.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=abdFmNcsECoR79OU0G3j1d0fC5CAfSYqSuchh5-MZ2U,2088
-nominal_api/_impl.py,sha256=i13o-HLfEfWZJUGAqHNLj_iNwS8nrvMOO3Bf0Ny6MpY,3803479
+nominal_api/__init__.py,sha256=OpxlifX4PfT4snnBIgc62lMjqBzQEwwwHg3CsYFihOo,2088
+nominal_api/_impl.py,sha256=9ZsccbROFkQd7FGzLNjpeJ_XgIc-7aM7AA4alqeibVM,3809312
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=GqRLE9wwPPQgALVHFJViG8E4JJ2t3yfHedeXRLu1L70,2226
 nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -14,7 +14,7 @@ nominal_api/datasource_api/__init__.py,sha256=-Py2STiLyAzvX6RntC9niTX2BVVLeLlXY1
 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=kXgNJmtAyPqinPrDRt-fMG7SD2DhRdyufzwKUpdhVrU,3028
+nominal_api/event/__init__.py,sha256=_aeR1gPrNTKTqgZ5qh-WmRNNDVjwhKdFfzIwV7LA5Gs,3343
 nominal_api/ingest_api/__init__.py,sha256=06oFmfiJf5ma8wvNZpq9T6LWMoUCuJWuL5FOCgbZftw,10954
 nominal_api/ingest_workflow_api/__init__.py,sha256=pNfJTaKs2pcnt2p5uRJAOmLia5nx8TiFLk8sSAlSI2I,3055
 nominal_api/module/__init__.py,sha256=0WDeegesyYu_XyFvPJZz8ZdXdTJRJxivU0KEhq8J6ww,4631
@@ -60,7 +60,7 @@ nominal_api/scout_units_api/__init__.py,sha256=gf47pW6JIcP3FgL1UuHwkibj266FCRszL
 nominal_api/scout_versioning_api/__init__.py,sha256=AGSj6Gd1gDUnY3BTpXhPkEzCnrKIMfvs3S17m68HGfQ,1822
 nominal_api/scout_video/__init__.py,sha256=orm_3BDcBo2LaSHAf2lwO1vN4OX2oHwTI1QTTvF_pgE,286
 nominal_api/scout_video_api/__init__.py,sha256=kW6Tc4bHePsivAVb_i8tukohd7LkWyzPJKgsuBnCDpk,5628
-nominal_api/scout_workbookcommon_api/__init__.py,sha256=bFSGQ26a--qgaD_JbHDz0LtrY8TuMwKXXbY5I8HoSzo,1569
+nominal_api/scout_workbookcommon_api/__init__.py,sha256=aANX-QdlB7K3evmP8OEED8ga6QfuYXGlGgjGSM9TgVI,1645
 nominal_api/secrets_api/__init__.py,sha256=orauwNcjFEmZnIrx4Zos0oALO-RiczeRdlSXrWSsCno,1060
 nominal_api/security_api_workspace/__init__.py,sha256=ZFzrThMO0IDhajFC6fpp_giLx1LjTHuZbY-3sTFpX9I,1536
 nominal_api/storage_datasource_api/__init__.py,sha256=plSbtDZH_wwfUNUzK8E1TauvfmvlCgn85U0NbNhmVZo,620
@@ -78,7 +78,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.926.0.dist-info/METADATA,sha256=IkhiCNR-Xqvr152aeUaA5mctjyYUmG2hPK4kAmrfYN8,199
-nominal_api-0.926.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nominal_api-0.926.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.926.0.dist-info/RECORD,,
+nominal_api-0.928.0.dist-info/METADATA,sha256=7WeWpmHriMNQ452GYpn_D7wt9p8FCIV9R4vl3e0KxwQ,199
+nominal_api-0.928.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nominal_api-0.928.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.928.0.dist-info/RECORD,,