nominal-api 0.760.0__py3-none-any.whl → 0.762.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of nominal-api might be problematic. Click here for more details.

nominal_api/__init__.py CHANGED
@@ -78,5 +78,5 @@ __all__ = [
78
78
 
79
79
  __conjure_generator_version__ = "4.17.0"
80
80
 
81
- __version__ = "0.760.0"
81
+ __version__ = "0.762.0"
82
82
 
nominal_api/_impl.py CHANGED
@@ -14215,15 +14215,17 @@ class module_CreateModuleRequest(ConjureBeanType):
14215
14215
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
14216
14216
  return {
14217
14217
  'name': ConjureFieldDefinition('name', str),
14218
+ 'title': ConjureFieldDefinition('title', str),
14218
14219
  'description': ConjureFieldDefinition('description', str),
14219
14220
  'definition': ConjureFieldDefinition('definition', module_ModuleVersionDefinition),
14220
14221
  'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_rids_WorkspaceRid])
14221
14222
  }
14222
14223
 
14223
- __slots__: List[str] = ['_name', '_description', '_definition', '_workspace']
14224
+ __slots__: List[str] = ['_name', '_title', '_description', '_definition', '_workspace']
14224
14225
 
14225
- def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str, workspace: Optional[str] = None) -> None:
14226
+ def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str, title: str, workspace: Optional[str] = None) -> None:
14226
14227
  self._name = name
14228
+ self._title = title
14227
14229
  self._description = description
14228
14230
  self._definition = definition
14229
14231
  self._workspace = workspace
@@ -14234,6 +14236,10 @@ class module_CreateModuleRequest(ConjureBeanType):
14234
14236
  """
14235
14237
  return self._name
14236
14238
 
14239
+ @builtins.property
14240
+ def title(self) -> str:
14241
+ return self._title
14242
+
14237
14243
  @builtins.property
14238
14244
  def description(self) -> str:
14239
14245
  return self._description
@@ -14670,17 +14676,19 @@ class module_ModuleMetadata(ConjureBeanType):
14670
14676
  return {
14671
14677
  'rid': ConjureFieldDefinition('rid', modules_api_ModuleRid),
14672
14678
  'name': ConjureFieldDefinition('name', str),
14679
+ 'title': ConjureFieldDefinition('title', str),
14673
14680
  'description': ConjureFieldDefinition('description', str),
14674
14681
  'created_by': ConjureFieldDefinition('createdBy', scout_rids_api_UserRid),
14675
14682
  'created_at': ConjureFieldDefinition('createdAt', str),
14676
14683
  'archived_at': ConjureFieldDefinition('archivedAt', OptionalTypeWrapper[str])
14677
14684
  }
14678
14685
 
14679
- __slots__: List[str] = ['_rid', '_name', '_description', '_created_by', '_created_at', '_archived_at']
14686
+ __slots__: List[str] = ['_rid', '_name', '_title', '_description', '_created_by', '_created_at', '_archived_at']
14680
14687
 
14681
- def __init__(self, created_at: str, created_by: str, description: str, name: str, rid: str, archived_at: Optional[str] = None) -> None:
14688
+ def __init__(self, created_at: str, created_by: str, description: str, name: str, rid: str, title: str, archived_at: Optional[str] = None) -> None:
14682
14689
  self._rid = rid
14683
14690
  self._name = name
14691
+ self._title = title
14684
14692
  self._description = description
14685
14693
  self._created_by = created_by
14686
14694
  self._created_at = created_at
@@ -14696,6 +14704,10 @@ class module_ModuleMetadata(ConjureBeanType):
14696
14704
  """
14697
14705
  return self._name
14698
14706
 
14707
+ @builtins.property
14708
+ def title(self) -> str:
14709
+ return self._title
14710
+
14699
14711
  @builtins.property
14700
14712
  def description(self) -> str:
14701
14713
  return self._description
@@ -15869,23 +15881,21 @@ class module_UpdateModuleRequest(ConjureBeanType):
15869
15881
  @builtins.classmethod
15870
15882
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
15871
15883
  return {
15872
- 'name': ConjureFieldDefinition('name', str),
15884
+ 'title': ConjureFieldDefinition('title', str),
15873
15885
  'description': ConjureFieldDefinition('description', str),
15874
15886
  'definition': ConjureFieldDefinition('definition', module_ModuleVersionDefinition)
15875
15887
  }
15876
15888
 
15877
- __slots__: List[str] = ['_name', '_description', '_definition']
15889
+ __slots__: List[str] = ['_title', '_description', '_definition']
15878
15890
 
15879
- def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str) -> None:
15880
- self._name = name
15891
+ def __init__(self, definition: "module_ModuleVersionDefinition", description: str, title: str) -> None:
15892
+ self._title = title
15881
15893
  self._description = description
15882
15894
  self._definition = definition
15883
15895
 
15884
15896
  @builtins.property
15885
- def name(self) -> str:
15886
- """The name of the module. This should be unique to the module in the current workspace.
15887
- """
15888
- return self._name
15897
+ def title(self) -> str:
15898
+ return self._title
15889
15899
 
15890
15900
  @builtins.property
15891
15901
  def description(self) -> str:
@@ -18499,7 +18509,7 @@ includes metrics for check and violation review status.
18499
18509
  _decoder = ConjureDecoder()
18500
18510
  return _decoder.decode(_response.json(), scout_run_api_SearchRunsWithDataReviewSummaryResponse, self._return_none_for_unknown_union_types)
18501
18511
 
18502
- def archive_run(self, auth_header: str, rid: str) -> bool:
18512
+ def archive_run(self, auth_header: str, rid: str, include_linked_workbooks: Optional[bool] = None) -> bool:
18503
18513
  """Soft-deletes a run. Runs still exist in the database but are no longer visible.
18504
18514
  """
18505
18515
  _conjure_encoder = ConjureEncoder()
@@ -18510,6 +18520,7 @@ includes metrics for check and violation review status.
18510
18520
  }
18511
18521
 
18512
18522
  _params: Dict[str, Any] = {
18523
+ 'includeLinkedWorkbooks': _conjure_encoder.default(include_linked_workbooks),
18513
18524
  }
18514
18525
 
18515
18526
  _path_params: Dict[str, str] = {
@@ -18531,7 +18542,7 @@ includes metrics for check and violation review status.
18531
18542
  _decoder = ConjureDecoder()
18532
18543
  return _decoder.decode(_response.json(), bool, self._return_none_for_unknown_union_types)
18533
18544
 
18534
- def unarchive_run(self, auth_header: str, rid: str) -> bool:
18545
+ def unarchive_run(self, auth_header: str, rid: str, include_linked_workbooks: Optional[bool] = None) -> bool:
18535
18546
  _conjure_encoder = ConjureEncoder()
18536
18547
 
18537
18548
  _headers: Dict[str, Any] = {
@@ -18540,6 +18551,7 @@ includes metrics for check and violation review status.
18540
18551
  }
18541
18552
 
18542
18553
  _params: Dict[str, Any] = {
18554
+ 'includeLinkedWorkbooks': _conjure_encoder.default(include_linked_workbooks),
18543
18555
  }
18544
18556
 
18545
18557
  _path_params: Dict[str, str] = {
@@ -49064,7 +49076,7 @@ class scout_compute_api_StabilityDetectionRanges(ConjureBeanType):
49064
49076
  the specified lookback window, including the current point. A point is considered stable if its value does
49065
49077
  not deviate from the calculated min and the max by more than the threshold and the total number of points
49066
49078
  within the window is at least the specified amount. The threshold can be either fixed values or percentages
49067
- of the value. The minimum points threshold defaults to 2.
49079
+ of the value. The lookback window must be strictly positive. The minimum points threshold defaults to 2.
49068
49080
  """
49069
49081
 
49070
49082
  @builtins.classmethod
@@ -62861,6 +62873,7 @@ If commitId is omitted from a ChecklistRef, it will match all commits.
62861
62873
  return {
62862
62874
  'run_rids': ConjureFieldDefinition('runRids', List[scout_run_api_RunRid]),
62863
62875
  'asset_rids': ConjureFieldDefinition('assetRids', List[scout_rids_api_AssetRid]),
62876
+ 'filter_by_both_runs_and_assets': ConjureFieldDefinition('filterByBothRunsAndAssets', OptionalTypeWrapper[bool]),
62864
62877
  'checklist_refs': ConjureFieldDefinition('checklistRefs', List[scout_checks_api_ChecklistRef]),
62865
62878
  'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[api_Token]),
62866
62879
  'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
@@ -62868,11 +62881,12 @@ If commitId is omitted from a ChecklistRef, it will match all commits.
62868
62881
  'archived_statuses': ConjureFieldDefinition('archivedStatuses', OptionalTypeWrapper[List[api_ArchivedStatus]])
62869
62882
  }
62870
62883
 
62871
- __slots__: List[str] = ['_run_rids', '_asset_rids', '_checklist_refs', '_next_page_token', '_page_size', '_show_archived', '_archived_statuses']
62884
+ __slots__: List[str] = ['_run_rids', '_asset_rids', '_filter_by_both_runs_and_assets', '_checklist_refs', '_next_page_token', '_page_size', '_show_archived', '_archived_statuses']
62872
62885
 
62873
- 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:
62886
+ 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:
62874
62887
  self._run_rids = run_rids
62875
62888
  self._asset_rids = asset_rids
62889
+ self._filter_by_both_runs_and_assets = filter_by_both_runs_and_assets
62876
62890
  self._checklist_refs = checklist_refs
62877
62891
  self._next_page_token = next_page_token
62878
62892
  self._page_size = page_size
@@ -62887,6 +62901,16 @@ If commitId is omitted from a ChecklistRef, it will match all commits.
62887
62901
  def asset_rids(self) -> List[str]:
62888
62902
  return self._asset_rids
62889
62903
 
62904
+ @builtins.property
62905
+ def filter_by_both_runs_and_assets(self) -> Optional[bool]:
62906
+ """If true, results are filtered to data reviews w/ both run and asset in the requested runs/assets.
62907
+ Defaults to false, where assets are converted to runs and all data reviews under the linked runs
62908
+ (including data reviews on other assets sharing the parent run) will be returned.
62909
+ It is recommended to set this to true and pass in asset RIDs for multi-asset runs.
62910
+ Toggling this option has no effect if no asset RIDs are supplied.
62911
+ """
62912
+ return self._filter_by_both_runs_and_assets
62913
+
62890
62914
  @builtins.property
62891
62915
  def checklist_refs(self) -> List["scout_checks_api_ChecklistRef"]:
62892
62916
  return self._checklist_refs
@@ -70070,6 +70094,8 @@ class scout_metadata_ResourceType(ConjureEnumType):
70070
70094
  '''EVENT'''
70071
70095
  DATASET = 'DATASET'
70072
70096
  '''DATASET'''
70097
+ MODULE = 'MODULE'
70098
+ '''MODULE'''
70073
70099
  UNKNOWN = 'UNKNOWN'
70074
70100
  '''UNKNOWN'''
70075
70101
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.760.0
3
+ Version: 0.762.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<4,>=2.8.0
@@ -1,5 +1,5 @@
1
- nominal_api/__init__.py,sha256=am5uus2gUqrSCtj8OoUcwZaJrWGoO-b9P_QpJHXe08s,2012
2
- nominal_api/_impl.py,sha256=zbDCvJsApmmli8LYz63v_L3gYpjcqOWIKDwWZhaoIyA,3406068
1
+ nominal_api/__init__.py,sha256=0o_JhWddWc03t3Zu1Ut2FUQTQz2-UY9nGkHXAoasFME,2012
2
+ nominal_api/_impl.py,sha256=iNAooHWmaDKu1wPXV-RT6nKVDnKoluMU26tszMr6WT0,3407590
3
3
  nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
4
4
  nominal_api/api/__init__.py,sha256=PMREKP7UhxJ1_gHkrlJET46qlDHksKMm6-woR1p6WnU,1970
5
5
  nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -75,7 +75,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=BwdqHLq_98LOsRV14JA3
75
75
  nominal_api/timeseries_seriescache/__init__.py,sha256=hL5hN8jKLEGE_fDiZzdASmWIrRjU6tncpmDeuc_47P4,150
76
76
  nominal_api/timeseries_seriescache_api/__init__.py,sha256=USBxFmNnVFdnhTPLvWi3UgsvBZ4Iz4ycNgBTi10F-zI,1603
77
77
  nominal_api/upload_api/__init__.py,sha256=7-XXuZUqKPV4AMWvxNpZPZ5vBun4x-AomXj3Vol_BN4,123
78
- nominal_api-0.760.0.dist-info/METADATA,sha256=mQt7WcDGVsuE6FDrhOkalWYOJvSy2EQ0ejsI7t81loo,199
79
- nominal_api-0.760.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
80
- nominal_api-0.760.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
81
- nominal_api-0.760.0.dist-info/RECORD,,
78
+ nominal_api-0.762.0.dist-info/METADATA,sha256=ljEwbHL8pyjisTmy4sUEsopmez36oSG-kMt9FK7-1qs,199
79
+ nominal_api-0.762.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
80
+ nominal_api-0.762.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
81
+ nominal_api-0.762.0.dist-info/RECORD,,