nominal-api 0.682.0__tar.gz → 0.684.0__tar.gz

{nominal_api-0.682.0 → nominal_api-0.684.0}/PKG-INFO

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

{nominal_api-0.682.0 → nominal_api-0.684.0}/nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.682.0"
+__version__ = "0.684.0"
 

{nominal_api-0.682.0 → nominal_api-0.684.0}/nominal_api/_impl.py

@@ -12598,18 +12598,24 @@ class ingest_workflow_api_GetExtractorJobStateResponse(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'state': ConjureFieldDefinition('state', ingest_workflow_api_ExtractorJobState)
+            'state': ConjureFieldDefinition('state', ingest_workflow_api_ExtractorJobState),
+            'message': ConjureFieldDefinition('message', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_state']
+    __slots__: List[str] = ['_state', '_message']
 
-    def __init__(self, state: "ingest_workflow_api_ExtractorJobState") -> None:
+    def __init__(self, state: "ingest_workflow_api_ExtractorJobState", message: Optional[str] = None) -> None:
         self._state = state
+        self._message = message
 
     @builtins.property
     def state(self) -> "ingest_workflow_api_ExtractorJobState":
         return self._state
 
+    @builtins.property
+    def message(self) -> Optional[str]:
+        return self._message
+
 
 ingest_workflow_api_GetExtractorJobStateResponse.__name__ = "GetExtractorJobStateResponse"
 ingest_workflow_api_GetExtractorJobStateResponse.__qualname__ = "GetExtractorJobStateResponse"
@@ -22571,7 +22577,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 +22585,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 +22597,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 +23135,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 +23143,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 +23155,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 +26570,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 +26578,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
@@ -63598,7 +63604,7 @@ class scout_integrations_api_IntegrationsService(Service):
     Service for managing integrations with external services.
     """
 
-    def generate_slack_webhook_link(self, auth_header: str, workspace: Optional[str] = None) -> "scout_integrations_api_GenerateSlackWebhookResponse":
+    def generate_slack_webhook_link(self, auth_header: str, is_gov_slack: Optional[bool] = None, workspace: Optional[str] = None) -> "scout_integrations_api_GenerateSlackWebhookResponse":
         """
         Generates link to request permissions for Slack bot to join workspaces and use a webhook.
         """
@@ -63610,6 +63616,7 @@ class scout_integrations_api_IntegrationsService(Service):
 
         _params: Dict[str, Any] = {
             'workspace': workspace,
+            'isGovSlack': is_gov_slack,
         }
 
         _path_params: Dict[str, Any] = {
@@ -63869,14 +63876,16 @@ class scout_integrations_api_NotificationConfiguration(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'integration_rid': ConjureFieldDefinition('integrationRid', scout_integrations_api_IntegrationRid),
+            'notification_filters': ConjureFieldDefinition('notificationFilters', OptionalTypeWrapper[List[scout_integrations_api_NotificationFilter]]),
             'appended_workbook_rid': ConjureFieldDefinition('appendedWorkbookRid', OptionalTypeWrapper[scout_rids_api_NotebookRid]),
             'tags': ConjureFieldDefinition('tags', List[str])
         }
 
-    __slots__: List[str] = ['_integration_rid', '_appended_workbook_rid', '_tags']
+    __slots__: List[str] = ['_integration_rid', '_notification_filters', '_appended_workbook_rid', '_tags']
 
-    def __init__(self, integration_rid: str, tags: List[str], appended_workbook_rid: Optional[str] = None) -> None:
+    def __init__(self, integration_rid: str, tags: List[str], appended_workbook_rid: Optional[str] = None, notification_filters: Optional[List["scout_integrations_api_NotificationFilter"]] = None) -> None:
         self._integration_rid = integration_rid
+        self._notification_filters = notification_filters
         self._appended_workbook_rid = appended_workbook_rid
         self._tags = tags
 
@@ -63884,6 +63893,13 @@ class scout_integrations_api_NotificationConfiguration(ConjureBeanType):
     def integration_rid(self) -> str:
         return self._integration_rid
 
+    @builtins.property
+    def notification_filters(self) -> Optional[List["scout_integrations_api_NotificationFilter"]]:
+        """
+        Specifies the type of notifications to filter. If not provided, all notifications are sent.
+        """
+        return self._notification_filters
+
     @builtins.property
     def appended_workbook_rid(self) -> Optional[str]:
         """
@@ -63904,6 +63920,25 @@ scout_integrations_api_NotificationConfiguration.__qualname__ = "NotificationCon
 scout_integrations_api_NotificationConfiguration.__module__ = "nominal_api.scout_integrations_api"
 
 
+class scout_integrations_api_NotificationFilter(ConjureEnumType):
+    """
+    Specifies a type of notification to filter.
+    """
+
+    EXECUTION_ERROR = 'EXECUTION_ERROR'
+    '''EXECUTION_ERROR'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_integrations_api_NotificationFilter.__name__ = "NotificationFilter"
+scout_integrations_api_NotificationFilter.__qualname__ = "NotificationFilter"
+scout_integrations_api_NotificationFilter.__module__ = "nominal_api.scout_integrations_api"
+
+
 class scout_integrations_api_OpsgenieIntegration(ConjureBeanType):
 
     @builtins.classmethod
@@ -65642,6 +65677,8 @@ class scout_metadata_ResourceType(ConjureEnumType):
     '''VIDEO'''
     ASSET = 'ASSET'
     '''ASSET'''
+    EVENT = 'EVENT'
+    '''EVENT'''
     UNKNOWN = 'UNKNOWN'
     '''UNKNOWN'''
 
@@ -65706,13 +65743,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 +65824,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 +65930,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 +65994,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 +66766,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 +66820,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 +74242,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.682.0 → nominal_api-0.684.0}/nominal_api/scout_integrations_api/__init__.py

@@ -12,6 +12,7 @@ from .._impl import (
     scout_integrations_api_IntegrationRid as IntegrationRid,
     scout_integrations_api_IntegrationsService as IntegrationsService,
     scout_integrations_api_NotificationConfiguration as NotificationConfiguration,
+    scout_integrations_api_NotificationFilter as NotificationFilter,
     scout_integrations_api_OpsgenieIntegration as OpsgenieIntegration,
     scout_integrations_api_OpsgenieRegion as OpsgenieRegion,
     scout_integrations_api_SendMessageRequest as SendMessageRequest,

{nominal_api-0.682.0 → nominal_api-0.684.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.682.0 → nominal_api-0.684.0}/setup.py

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