nominal-api 0.681.0__py3-none-any.whl → 0.683.0__py3-none-any.whl

nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.681.0"
+__version__ = "0.683.0"
 

nominal_api/_impl.py

@@ -22571,7 +22571,7 @@ class scout_chartdefinition_api_CartesianChartDefinitionV1(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'plots': ConjureFieldDefinition('plots', List[scout_chartdefinition_api_CartesianPlot]),
-            'events': ConjureFieldDefinition('events', List[scout_chartdefinition_api_Event]),
+            'events': ConjureFieldDefinition('events', OptionalTypeWrapper[List[scout_chartdefinition_api_Event]]),
             'comparison_run_groups': ConjureFieldDefinition('comparisonRunGroups', List[scout_comparisonrun_api_ComparisonRunGroup]),
             'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
             'value_axes': ConjureFieldDefinition('valueAxes', List[scout_chartdefinition_api_ValueAxis])
@@ -22579,7 +22579,7 @@ class scout_chartdefinition_api_CartesianChartDefinitionV1(ConjureBeanType):
 
     __slots__: List[str] = ['_plots', '_events', '_comparison_run_groups', '_title', '_value_axes']
 
-    def __init__(self, comparison_run_groups: List["scout_comparisonrun_api_ComparisonRunGroup"], events: List["scout_chartdefinition_api_Event"], plots: List["scout_chartdefinition_api_CartesianPlot"], value_axes: List["scout_chartdefinition_api_ValueAxis"], title: Optional[str] = None) -> None:
+    def __init__(self, comparison_run_groups: List["scout_comparisonrun_api_ComparisonRunGroup"], plots: List["scout_chartdefinition_api_CartesianPlot"], value_axes: List["scout_chartdefinition_api_ValueAxis"], events: Optional[List["scout_chartdefinition_api_Event"]] = None, title: Optional[str] = None) -> None:
         self._plots = plots
         self._events = events
         self._comparison_run_groups = comparison_run_groups
@@ -22591,7 +22591,7 @@ class scout_chartdefinition_api_CartesianChartDefinitionV1(ConjureBeanType):
         return self._plots
 
     @builtins.property
-    def events(self) -> List["scout_chartdefinition_api_Event"]:
+    def events(self) -> Optional[List["scout_chartdefinition_api_Event"]]:
         return self._events
 
     @builtins.property
@@ -23129,7 +23129,7 @@ class scout_chartdefinition_api_FrequencyChartDefinitionV1(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'plots': ConjureFieldDefinition('plots', List[scout_chartdefinition_api_FrequencyPlot]),
-            'events': ConjureFieldDefinition('events', List[scout_chartdefinition_api_Event]),
+            'events': ConjureFieldDefinition('events', OptionalTypeWrapper[List[scout_chartdefinition_api_Event]]),
             'comparison_run_groups': ConjureFieldDefinition('comparisonRunGroups', List[scout_comparisonrun_api_ComparisonRunGroup]),
             'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
             'value_axes': ConjureFieldDefinition('valueAxes', List[scout_chartdefinition_api_ValueAxis])
@@ -23137,7 +23137,7 @@ class scout_chartdefinition_api_FrequencyChartDefinitionV1(ConjureBeanType):
 
     __slots__: List[str] = ['_plots', '_events', '_comparison_run_groups', '_title', '_value_axes']
 
-    def __init__(self, comparison_run_groups: List["scout_comparisonrun_api_ComparisonRunGroup"], events: List["scout_chartdefinition_api_Event"], plots: List["scout_chartdefinition_api_FrequencyPlot"], value_axes: List["scout_chartdefinition_api_ValueAxis"], title: Optional[str] = None) -> None:
+    def __init__(self, comparison_run_groups: List["scout_comparisonrun_api_ComparisonRunGroup"], plots: List["scout_chartdefinition_api_FrequencyPlot"], value_axes: List["scout_chartdefinition_api_ValueAxis"], events: Optional[List["scout_chartdefinition_api_Event"]] = None, title: Optional[str] = None) -> None:
         self._plots = plots
         self._events = events
         self._comparison_run_groups = comparison_run_groups
@@ -23149,7 +23149,7 @@ class scout_chartdefinition_api_FrequencyChartDefinitionV1(ConjureBeanType):
         return self._plots
 
     @builtins.property
-    def events(self) -> List["scout_chartdefinition_api_Event"]:
+    def events(self) -> Optional[List["scout_chartdefinition_api_Event"]]:
         return self._events
 
     @builtins.property
@@ -26564,7 +26564,7 @@ class scout_chartdefinition_api_VideoVizDefinitionV1(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'events': ConjureFieldDefinition('events', List[scout_chartdefinition_api_Event]),
+            'events': ConjureFieldDefinition('events', OptionalTypeWrapper[List[scout_chartdefinition_api_Event]]),
             'comparison_run_groups': ConjureFieldDefinition('comparisonRunGroups', List[scout_comparisonrun_api_ComparisonRunGroup]),
             'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
             'ref_name': ConjureFieldDefinition('refName', OptionalTypeWrapper[scout_chartdefinition_api_DataSourceRefName])
@@ -26572,14 +26572,14 @@ class scout_chartdefinition_api_VideoVizDefinitionV1(ConjureBeanType):
 
     __slots__: List[str] = ['_events', '_comparison_run_groups', '_title', '_ref_name']
 
-    def __init__(self, comparison_run_groups: List["scout_comparisonrun_api_ComparisonRunGroup"], events: List["scout_chartdefinition_api_Event"], ref_name: Optional[str] = None, title: Optional[str] = None) -> None:
+    def __init__(self, comparison_run_groups: List["scout_comparisonrun_api_ComparisonRunGroup"], events: Optional[List["scout_chartdefinition_api_Event"]] = None, ref_name: Optional[str] = None, title: Optional[str] = None) -> None:
         self._events = events
         self._comparison_run_groups = comparison_run_groups
         self._title = title
         self._ref_name = ref_name
 
     @builtins.property
-    def events(self) -> List["scout_chartdefinition_api_Event"]:
+    def events(self) -> Optional[List["scout_chartdefinition_api_Event"]]:
         return self._events
 
     @builtins.property
@@ -65706,13 +65706,13 @@ class scout_notebook_api_CreateNotebookRequest(ConjureBeanType):
             'content': ConjureFieldDefinition('content', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookContent]),
             'content_v2': ConjureFieldDefinition('contentV2', OptionalTypeWrapper[scout_workbookcommon_api_UnifiedWorkbookContent]),
             'event_refs': ConjureFieldDefinition('eventRefs', List[scout_workbookcommon_api_EventReference]),
-            'check_alert_refs': ConjureFieldDefinition('checkAlertRefs', List[scout_workbookcommon_api_CheckAlertReference]),
+            'check_alert_refs': ConjureFieldDefinition('checkAlertRefs', OptionalTypeWrapper[List[scout_workbookcommon_api_CheckAlertReference]]),
             'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_rids_WorkspaceRid])
         }
 
     __slots__: List[str] = ['_title', '_description', '_notebook_type', '_is_draft', '_state_as_json', '_charts', '_run_rid', '_data_scope', '_layout', '_content', '_content_v2', '_event_refs', '_check_alert_refs', '_workspace']
 
-    def __init__(self, check_alert_refs: List["scout_workbookcommon_api_CheckAlertReference"], description: str, event_refs: List["scout_workbookcommon_api_EventReference"], is_draft: bool, layout: "scout_layout_api_WorkbookLayout", state_as_json: str, title: str, charts: Optional[List["scout_notebook_api_ChartWithOverlays"]] = None, content: Optional["scout_workbookcommon_api_WorkbookContent"] = None, content_v2: Optional["scout_workbookcommon_api_UnifiedWorkbookContent"] = None, data_scope: Optional["scout_notebook_api_NotebookDataScope"] = None, notebook_type: Optional["scout_notebook_api_NotebookType"] = None, run_rid: Optional[str] = None, workspace: Optional[str] = None) -> None:
+    def __init__(self, description: str, event_refs: List["scout_workbookcommon_api_EventReference"], is_draft: bool, layout: "scout_layout_api_WorkbookLayout", state_as_json: str, title: str, charts: Optional[List["scout_notebook_api_ChartWithOverlays"]] = None, check_alert_refs: Optional[List["scout_workbookcommon_api_CheckAlertReference"]] = None, content: Optional["scout_workbookcommon_api_WorkbookContent"] = None, content_v2: Optional["scout_workbookcommon_api_UnifiedWorkbookContent"] = None, data_scope: Optional["scout_notebook_api_NotebookDataScope"] = None, notebook_type: Optional["scout_notebook_api_NotebookType"] = None, run_rid: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._title = title
         self._description = description
         self._notebook_type = notebook_type
@@ -65787,14 +65787,15 @@ class scout_notebook_api_CreateNotebookRequest(ConjureBeanType):
     @builtins.property
     def event_refs(self) -> List["scout_workbookcommon_api_EventReference"]:
         """
-        Field to pin events to a workbook on creation. Optional for backcompatibility.
+        Field to pin events to a workbook on creation.
         """
         return self._event_refs
 
     @builtins.property
-    def check_alert_refs(self) -> List["scout_workbookcommon_api_CheckAlertReference"]:
+    def check_alert_refs(self) -> Optional[List["scout_workbookcommon_api_CheckAlertReference"]]:
         """
-        Field to pin check alerts to a workbook on creation. Optional for backcompatibility.
+        Field to pin check alerts to a workbook on creation.
+Any specified CheckAlertReference will be added to the workbook along with it's corresponding EventReference.
         """
         return self._check_alert_refs
 
@@ -65892,12 +65893,12 @@ class scout_notebook_api_Notebook(ConjureBeanType):
             'content': ConjureFieldDefinition('content', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookContent]),
             'content_v2': ConjureFieldDefinition('contentV2', scout_workbookcommon_api_UnifiedWorkbookContent),
             'event_refs': ConjureFieldDefinition('eventRefs', List[scout_workbookcommon_api_EventReference]),
-            'check_alert_refs': ConjureFieldDefinition('checkAlertRefs', List[scout_workbookcommon_api_CheckAlertReference])
+            'check_alert_refs': ConjureFieldDefinition('checkAlertRefs', OptionalTypeWrapper[List[scout_workbookcommon_api_CheckAlertReference]])
         }
 
     __slots__: List[str] = ['_rid', '_snapshot_rid', '_snapshot_author_rid', '_snapshot_created_at', '_metadata', '_state_as_json', '_charts', '_layout', '_content', '_content_v2', '_event_refs', '_check_alert_refs']
 
-    def __init__(self, check_alert_refs: List["scout_workbookcommon_api_CheckAlertReference"], content_v2: "scout_workbookcommon_api_UnifiedWorkbookContent", event_refs: List["scout_workbookcommon_api_EventReference"], layout: "scout_layout_api_WorkbookLayout", metadata: "scout_notebook_api_NotebookMetadata", rid: str, snapshot_author_rid: str, snapshot_created_at: str, snapshot_rid: str, state_as_json: str, charts: Optional[List["scout_notebook_api_ChartWithOverlays"]] = None, content: Optional["scout_workbookcommon_api_WorkbookContent"] = None) -> None:
+    def __init__(self, content_v2: "scout_workbookcommon_api_UnifiedWorkbookContent", event_refs: List["scout_workbookcommon_api_EventReference"], layout: "scout_layout_api_WorkbookLayout", metadata: "scout_notebook_api_NotebookMetadata", rid: str, snapshot_author_rid: str, snapshot_created_at: str, snapshot_rid: str, state_as_json: str, charts: Optional[List["scout_notebook_api_ChartWithOverlays"]] = None, check_alert_refs: Optional[List["scout_workbookcommon_api_CheckAlertReference"]] = None, content: Optional["scout_workbookcommon_api_WorkbookContent"] = None) -> None:
         self._rid = rid
         self._snapshot_rid = snapshot_rid
         self._snapshot_author_rid = snapshot_author_rid
@@ -65956,7 +65957,7 @@ class scout_notebook_api_Notebook(ConjureBeanType):
         return self._event_refs
 
     @builtins.property
-    def check_alert_refs(self) -> List["scout_workbookcommon_api_CheckAlertReference"]:
+    def check_alert_refs(self) -> Optional[List["scout_workbookcommon_api_CheckAlertReference"]]:
         return self._check_alert_refs
 
 
@@ -66728,12 +66729,12 @@ class scout_notebook_api_UpdateNotebookRequest(ConjureBeanType):
             'content_v2': ConjureFieldDefinition('contentV2', OptionalTypeWrapper[scout_workbookcommon_api_UnifiedWorkbookContent]),
             'latest_snapshot_rid': ConjureFieldDefinition('latestSnapshotRid', OptionalTypeWrapper[scout_rids_api_SnapshotRid]),
             'event_refs': ConjureFieldDefinition('eventRefs', List[scout_workbookcommon_api_EventReference]),
-            'check_alert_refs': ConjureFieldDefinition('checkAlertRefs', List[scout_workbookcommon_api_CheckAlertReference])
+            'check_alert_refs': ConjureFieldDefinition('checkAlertRefs', OptionalTypeWrapper[List[scout_workbookcommon_api_CheckAlertReference]])
         }
 
     __slots__: List[str] = ['_state_as_json', '_charts', '_layout', '_content', '_content_v2', '_latest_snapshot_rid', '_event_refs', '_check_alert_refs']
 
-    def __init__(self, check_alert_refs: List["scout_workbookcommon_api_CheckAlertReference"], event_refs: List["scout_workbookcommon_api_EventReference"], layout: "scout_layout_api_WorkbookLayout", state_as_json: str, charts: Optional[List["scout_notebook_api_ChartWithOverlays"]] = None, content: Optional["scout_workbookcommon_api_WorkbookContent"] = None, content_v2: Optional["scout_workbookcommon_api_UnifiedWorkbookContent"] = None, latest_snapshot_rid: Optional[str] = None) -> None:
+    def __init__(self, event_refs: List["scout_workbookcommon_api_EventReference"], layout: "scout_layout_api_WorkbookLayout", state_as_json: str, charts: Optional[List["scout_notebook_api_ChartWithOverlays"]] = None, check_alert_refs: Optional[List["scout_workbookcommon_api_CheckAlertReference"]] = None, content: Optional["scout_workbookcommon_api_WorkbookContent"] = None, content_v2: Optional["scout_workbookcommon_api_UnifiedWorkbookContent"] = None, latest_snapshot_rid: Optional[str] = None) -> None:
         self._state_as_json = state_as_json
         self._charts = charts
         self._layout = layout
@@ -66782,9 +66783,12 @@ and throws SaveNotebookConflict otherwise.
         return self._event_refs
 
     @builtins.property
-    def check_alert_refs(self) -> List["scout_workbookcommon_api_CheckAlertReference"]:
+    def check_alert_refs(self) -> Optional[List["scout_workbookcommon_api_CheckAlertReference"]]:
         """
-        Replace existing pinned check alerts on the workbook.
+        Field to pin check alerts to a workbook on creation.
+If not provided, will keep the set of check alerts on the workbook unchanged.
+Providing an empty set will remove all check alerts from the workbook.
+Any specified CheckAlertReference will be added to the workbook along with it's corresponding EventReference.
         """
         return self._check_alert_refs
 
@@ -74201,22 +74205,22 @@ class scout_workbookcommon_api_EventReference(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'event_uuid': ConjureFieldDefinition('eventUuid', str),
-            'rid': ConjureFieldDefinition('rid', OptionalTypeWrapper[api_rids_EventRid])
+            'event_uuid': ConjureFieldDefinition('eventUuid', OptionalTypeWrapper[str]),
+            'rid': ConjureFieldDefinition('rid', api_rids_EventRid)
         }
 
     __slots__: List[str] = ['_event_uuid', '_rid']
 
-    def __init__(self, event_uuid: str, rid: Optional[str] = None) -> None:
+    def __init__(self, rid: str, event_uuid: Optional[str] = None) -> None:
         self._event_uuid = event_uuid
         self._rid = rid
 
     @builtins.property
-    def event_uuid(self) -> str:
+    def event_uuid(self) -> Optional[str]:
         return self._event_uuid
 
     @builtins.property
-    def rid(self) -> Optional[str]:
+    def rid(self) -> str:
         """
         The event's unique identifier. This will soon be a required field.
         """

{nominal_api-0.681.0.dist-info → nominal_api-0.683.0.dist-info}/METADATA

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

{nominal_api-0.681.0.dist-info → nominal_api-0.683.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=82jUXrR6k5wFQIi63f4fLCCyBUj65HZtZFIm03WNpzg,1955
-nominal_api/_impl.py,sha256=NN7KGIDyjyCXWdTri_bkiP2DKECxiDpp-wtwMwx8eII,3162935
+nominal_api/__init__.py,sha256=NoYbPE68Uv2ICNgr4dFBh2e6mOAoK6J5-twRClBuH8A,1955
+nominal_api/_impl.py,sha256=i_M1uxQp4742XnxA_pB8lP8FBgDtk9C0lvaEkn8kEow,3163527
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=1oJPOuAMfV2uClPUW8Ie1nj2Y6j81TDpedcc3yUFTe0,1294
 nominal_api/api_ids/__init__.py,sha256=CAtt44XgNZEEUDv-BbEbYtuxQ8y1wqSZU-STjBYdZv8,80
@@ -72,7 +72,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=Q9iZHurmyDsJIFbUg-Eb
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.681.0.dist-info/METADATA,sha256=j8HIN0TIXm6xq-yaioFgQLrLtldQ7z7nbCyNFGCb0k4,199
-nominal_api-0.681.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-nominal_api-0.681.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.681.0.dist-info/RECORD,,
+nominal_api-0.683.0.dist-info/METADATA,sha256=_RBrSGPlFUHOGfmgwcQc9TrbCwz6VfaoAnDF1AK9FKw,199
+nominal_api-0.683.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+nominal_api-0.683.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.683.0.dist-info/RECORD,,