nominal-api 0.761.0__tar.gz → 0.763.0__tar.gz

{nominal_api-0.761.0 → nominal_api-0.763.0}/PKG-INFO

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

{nominal_api-0.761.0 → nominal_api-0.763.0}/nominal_api/__init__.py

@@ -78,5 +78,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.761.0"
+__version__ = "0.763.0"
 

{nominal_api-0.761.0 → nominal_api-0.763.0}/nominal_api/_impl.py

@@ -14266,19 +14266,19 @@ class module_DerivedSeriesMetadata(ConjureBeanType):
             'function_name': ConjureFieldDefinition('functionName', str),
             'function_description': ConjureFieldDefinition('functionDescription', str),
             'module_name': ConjureFieldDefinition('moduleName', str),
-            'module_rid': ConjureFieldDefinition('moduleRid', modules_api_ModuleRid),
-            'asset_rid': ConjureFieldDefinition('assetRid', scout_rids_api_AssetRid),
+            'module_application_rid': ConjureFieldDefinition('moduleApplicationRid', modules_api_ModuleApplicationRid),
+            'application_resolved_parameters': ConjureFieldDefinition('applicationResolvedParameters', List[module_ModuleVariable]),
             'data_type': ConjureFieldDefinition('dataType', module_ValueType)
         }
 
-    __slots__: List[str] = ['_function_name', '_function_description', '_module_name', '_module_rid', '_asset_rid', '_data_type']
+    __slots__: List[str] = ['_function_name', '_function_description', '_module_name', '_module_application_rid', '_application_resolved_parameters', '_data_type']
 
-    def __init__(self, asset_rid: str, data_type: "module_ValueType", function_description: str, function_name: str, module_name: str, module_rid: str) -> None:
+    def __init__(self, application_resolved_parameters: List["module_ModuleVariable"], data_type: "module_ValueType", function_description: str, function_name: str, module_application_rid: str, module_name: str) -> None:
         self._function_name = function_name
         self._function_description = function_description
         self._module_name = module_name
-        self._module_rid = module_rid
-        self._asset_rid = asset_rid
+        self._module_application_rid = module_application_rid
+        self._application_resolved_parameters = application_resolved_parameters
         self._data_type = data_type
 
     @builtins.property
@@ -14294,12 +14294,14 @@ class module_DerivedSeriesMetadata(ConjureBeanType):
         return self._module_name
 
     @builtins.property
-    def module_rid(self) -> str:
-        return self._module_rid
+    def module_application_rid(self) -> str:
+        return self._module_application_rid
 
     @builtins.property
-    def asset_rid(self) -> str:
-        return self._asset_rid
+    def application_resolved_parameters(self) -> List["module_ModuleVariable"]:
+        """The parameters and their values that were resolved when the module was applied to the asset.
+        """
+        return self._application_resolved_parameters
 
     @builtins.property
     def data_type(self) -> "module_ValueType":
@@ -15964,11 +15966,34 @@ module_internal_BatchGetResolvedModuleDefinitionsRequest.__qualname__ = "BatchGe
 module_internal_BatchGetResolvedModuleDefinitionsRequest.__module__ = "nominal_api.module_internal"
 
 
+class module_internal_BatchGetResolvedModuleDefinitionsResponse(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'results': ConjureFieldDefinition('results', List[module_internal_ResolvedModuleVersionDefinition])
+        }
+
+    __slots__: List[str] = ['_results']
+
+    def __init__(self, results: List["module_internal_ResolvedModuleVersionDefinition"]) -> None:
+        self._results = results
+
+    @builtins.property
+    def results(self) -> List["module_internal_ResolvedModuleVersionDefinition"]:
+        return self._results
+
+
+module_internal_BatchGetResolvedModuleDefinitionsResponse.__name__ = "BatchGetResolvedModuleDefinitionsResponse"
+module_internal_BatchGetResolvedModuleDefinitionsResponse.__qualname__ = "BatchGetResolvedModuleDefinitionsResponse"
+module_internal_BatchGetResolvedModuleDefinitionsResponse.__module__ = "nominal_api.module_internal"
+
+
 class module_internal_InternalModuleService(Service):
     """This service provides internal APIs related to modules.
     """
 
-    def batch_get_resolved_module_definitions(self, auth_header: str, request: "module_internal_BatchGetResolvedModuleDefinitionsRequest") -> List["module_internal_ResolvedModuleVersionDefinition"]:
+    def batch_get_resolved_module_definitions(self, auth_header: str, request: "module_internal_BatchGetResolvedModuleDefinitionsRequest") -> "module_internal_BatchGetResolvedModuleDefinitionsResponse":
         """Returns the resolved module definitions for the given module-asset pairs. If any of modules have not been
 applied to their corresponding asset, this will throw.
         """
@@ -15999,7 +16024,7 @@ applied to their corresponding asset, this will throw.
             json=_json)
 
         _decoder = ConjureDecoder()
-        return _decoder.decode(_response.json(), List[module_internal_ResolvedModuleVersionDefinition], self._return_none_for_unknown_union_types)
+        return _decoder.decode(_response.json(), module_internal_BatchGetResolvedModuleDefinitionsResponse, self._return_none_for_unknown_union_types)
 
 
 module_internal_InternalModuleService.__name__ = "InternalModuleService"
@@ -16012,23 +16037,17 @@ class module_internal_ModuleApplicationReference(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'module_name': ConjureFieldDefinition('moduleName', str),
-            'asset_rid': ConjureFieldDefinition('assetRid', scout_rids_api_AssetRid)
+            'module_application_rid': ConjureFieldDefinition('moduleApplicationRid', modules_api_ModuleApplicationRid)
         }
 
-    __slots__: List[str] = ['_module_name', '_asset_rid']
-
-    def __init__(self, asset_rid: str, module_name: str) -> None:
-        self._module_name = module_name
-        self._asset_rid = asset_rid
+    __slots__: List[str] = ['_module_application_rid']
 
-    @builtins.property
-    def module_name(self) -> str:
-        return self._module_name
+    def __init__(self, module_application_rid: str) -> None:
+        self._module_application_rid = module_application_rid
 
     @builtins.property
-    def asset_rid(self) -> str:
-        return self._asset_rid
+    def module_application_rid(self) -> str:
+        return self._module_application_rid
 
 
 module_internal_ModuleApplicationReference.__name__ = "ModuleApplicationReference"
@@ -16041,29 +16060,23 @@ class module_internal_ResolvedModuleVersionDefinition(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'module_name': ConjureFieldDefinition('moduleName', str),
-            'asset_rid': ConjureFieldDefinition('assetRid', scout_rids_api_AssetRid),
+            'module_application_rid': ConjureFieldDefinition('moduleApplicationRid', modules_api_ModuleApplicationRid),
             'resolved_parameters': ConjureFieldDefinition('resolvedParameters', List[module_ModuleVariable]),
             'default_variables': ConjureFieldDefinition('defaultVariables', List[module_ModuleVariable]),
             'functions': ConjureFieldDefinition('functions', List[module_Function])
         }
 
-    __slots__: List[str] = ['_module_name', '_asset_rid', '_resolved_parameters', '_default_variables', '_functions']
+    __slots__: List[str] = ['_module_application_rid', '_resolved_parameters', '_default_variables', '_functions']
 
-    def __init__(self, asset_rid: str, default_variables: List["module_ModuleVariable"], functions: List["module_Function"], module_name: str, resolved_parameters: List["module_ModuleVariable"]) -> None:
-        self._module_name = module_name
-        self._asset_rid = asset_rid
+    def __init__(self, default_variables: List["module_ModuleVariable"], functions: List["module_Function"], module_application_rid: str, resolved_parameters: List["module_ModuleVariable"]) -> None:
+        self._module_application_rid = module_application_rid
         self._resolved_parameters = resolved_parameters
         self._default_variables = default_variables
         self._functions = functions
 
     @builtins.property
-    def module_name(self) -> str:
-        return self._module_name
-
-    @builtins.property
-    def asset_rid(self) -> str:
-        return self._asset_rid
+    def module_application_rid(self) -> str:
+        return self._module_application_rid
 
     @builtins.property
     def resolved_parameters(self) -> List["module_ModuleVariable"]:
@@ -18509,7 +18522,7 @@ includes metrics for check and violation review status.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), scout_run_api_SearchRunsWithDataReviewSummaryResponse, self._return_none_for_unknown_union_types)
 
-    def archive_run(self, auth_header: str, rid: str) -> bool:
+    def archive_run(self, auth_header: str, rid: str, include_linked_workbooks: Optional[bool] = None) -> bool:
         """Soft-deletes a run. Runs still exist in the database but are no longer visible.
         """
         _conjure_encoder = ConjureEncoder()
@@ -18520,6 +18533,7 @@ includes metrics for check and violation review status.
         }
 
         _params: Dict[str, Any] = {
+            'includeLinkedWorkbooks': _conjure_encoder.default(include_linked_workbooks),
         }
 
         _path_params: Dict[str, str] = {
@@ -18541,7 +18555,7 @@ includes metrics for check and violation review status.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), bool, self._return_none_for_unknown_union_types)
 
-    def unarchive_run(self, auth_header: str, rid: str) -> bool:
+    def unarchive_run(self, auth_header: str, rid: str, include_linked_workbooks: Optional[bool] = None) -> bool:
         _conjure_encoder = ConjureEncoder()
 
         _headers: Dict[str, Any] = {
@@ -18550,6 +18564,7 @@ includes metrics for check and violation review status.
         }
 
         _params: Dict[str, Any] = {
+            'includeLinkedWorkbooks': _conjure_encoder.default(include_linked_workbooks),
         }
 
         _path_params: Dict[str, str] = {
@@ -62871,6 +62886,7 @@ If commitId is omitted from a ChecklistRef, it will match all commits.
         return {
             'run_rids': ConjureFieldDefinition('runRids', List[scout_run_api_RunRid]),
             'asset_rids': ConjureFieldDefinition('assetRids', List[scout_rids_api_AssetRid]),
+            'filter_by_both_runs_and_assets': ConjureFieldDefinition('filterByBothRunsAndAssets', OptionalTypeWrapper[bool]),
             'checklist_refs': ConjureFieldDefinition('checklistRefs', List[scout_checks_api_ChecklistRef]),
             'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[api_Token]),
             'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
@@ -62878,11 +62894,12 @@ If commitId is omitted from a ChecklistRef, it will match all commits.
             'archived_statuses': ConjureFieldDefinition('archivedStatuses', OptionalTypeWrapper[List[api_ArchivedStatus]])
         }
 
-    __slots__: List[str] = ['_run_rids', '_asset_rids', '_checklist_refs', '_next_page_token', '_page_size', '_show_archived', '_archived_statuses']
+    __slots__: List[str] = ['_run_rids', '_asset_rids', '_filter_by_both_runs_and_assets', '_checklist_refs', '_next_page_token', '_page_size', '_show_archived', '_archived_statuses']
 
-    def __init__(self, asset_rids: List[str], checklist_refs: List["scout_checks_api_ChecklistRef"], run_rids: List[str], archived_statuses: Optional[List["api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None, page_size: Optional[int] = None, show_archived: Optional[bool] = None) -> None:
+    def __init__(self, asset_rids: List[str], checklist_refs: List["scout_checks_api_ChecklistRef"], run_rids: List[str], archived_statuses: Optional[List["api_ArchivedStatus"]] = None, filter_by_both_runs_and_assets: Optional[bool] = None, next_page_token: Optional[str] = None, page_size: Optional[int] = None, show_archived: Optional[bool] = None) -> None:
         self._run_rids = run_rids
         self._asset_rids = asset_rids
+        self._filter_by_both_runs_and_assets = filter_by_both_runs_and_assets
         self._checklist_refs = checklist_refs
         self._next_page_token = next_page_token
         self._page_size = page_size
@@ -62897,6 +62914,16 @@ If commitId is omitted from a ChecklistRef, it will match all commits.
     def asset_rids(self) -> List[str]:
         return self._asset_rids
 
+    @builtins.property
+    def filter_by_both_runs_and_assets(self) -> Optional[bool]:
+        """If true, results are filtered to data reviews w/ both run and asset in the requested runs/assets.
+Defaults to false, where assets are converted to runs and all data reviews under the linked runs
+(including data reviews on other assets sharing the parent run) will be returned.
+It is recommended to set this to true and pass in asset RIDs for multi-asset runs.
+Toggling this option has no effect if no asset RIDs are supplied.
+        """
+        return self._filter_by_both_runs_and_assets
+
     @builtins.property
     def checklist_refs(self) -> List["scout_checks_api_ChecklistRef"]:
         return self._checklist_refs
@@ -86500,6 +86527,8 @@ persistent_compute_api_SubscriptionId = str
 
 api_McapChannelTopic = str
 
+modules_api_ModuleApplicationRid = str
+
 scout_compute_api_VariableName = str
 
 scout_datasource_connection_api_MeasurementName = str
@@ -86654,8 +86683,6 @@ api_rids_EventRid = str
 
 persistent_compute_api_Milliseconds = int
 
-api_rids_StreamingConnectionRid = str
-
 ingest_api_IngestJobRid = str
 
 scout_compute_api_ErrorType = str
@@ -86668,10 +86695,14 @@ modules_api_ModuleRid = str
 
 timeseries_logicalseries_api_SchemaName = str
 
+scout_rids_api_MarkingRid = str
+
 scout_datasource_connection_api_BucketName = str
 
 api_S3Path = str
 
+api_rids_StreamingConnectionRid = str
+
 comments_api_ReactionRid = str
 
 scout_versioning_api_CommitId = str

{nominal_api-0.761.0 → nominal_api-0.763.0}/nominal_api/module_internal/__init__.py

@@ -1,6 +1,7 @@
 # coding=utf-8
 from .._impl import (
     module_internal_BatchGetResolvedModuleDefinitionsRequest as BatchGetResolvedModuleDefinitionsRequest,
+    module_internal_BatchGetResolvedModuleDefinitionsResponse as BatchGetResolvedModuleDefinitionsResponse,
     module_internal_InternalModuleService as InternalModuleService,
     module_internal_ModuleApplicationReference as ModuleApplicationReference,
     module_internal_ResolvedModuleVersionDefinition as ResolvedModuleVersionDefinition,
@@ -8,6 +9,7 @@ from .._impl import (
 
 __all__ = [
     'BatchGetResolvedModuleDefinitionsRequest',
+    'BatchGetResolvedModuleDefinitionsResponse',
     'ModuleApplicationReference',
     'ResolvedModuleVersionDefinition',
     'InternalModuleService',

{nominal_api-0.761.0 → nominal_api-0.763.0}/nominal_api/modules_api/__init__.py

@@ -1,9 +1,11 @@
 # coding=utf-8
 from .._impl import (
+    modules_api_ModuleApplicationRid as ModuleApplicationRid,
     modules_api_ModuleRid as ModuleRid,
 )
 
 __all__ = [
+    'ModuleApplicationRid',
     'ModuleRid',
 ]
 

{nominal_api-0.761.0 → nominal_api-0.763.0}/nominal_api/scout_rids_api/__init__.py

@@ -15,6 +15,7 @@ from .._impl import (
     scout_rids_api_FunctionLineageRid as FunctionLineageRid,
     scout_rids_api_FunctionRid as FunctionRid,
     scout_rids_api_GroupRid as GroupRid,
+    scout_rids_api_MarkingRid as MarkingRid,
     scout_rids_api_NotebookRid as NotebookRid,
     scout_rids_api_PendingReviewAlertState as PendingReviewAlertState,
     scout_rids_api_SnapshotRid as SnapshotRid,
@@ -42,6 +43,7 @@ __all__ = [
     'FunctionLineageRid',
     'FunctionRid',
     'GroupRid',
+    'MarkingRid',
     'NotebookRid',
     'PendingReviewAlertState',
     'SnapshotRid',

{nominal_api-0.761.0 → nominal_api-0.763.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.761.0 → nominal_api-0.763.0}/setup.py

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