nominal-api 0.585.0__py3-none-any.whl → 0.586.1__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
@@ -74,5 +74,5 @@ __all__ = [
74
74
 
75
75
  __conjure_generator_version__ = "4.9.0"
76
76
 
77
- __version__ = "0.585.0"
77
+ __version__ = "0.586.1"
78
78
 
nominal_api/_impl.py CHANGED
@@ -2035,10 +2035,10 @@ class authorization_AuthorizationService(Service):
2035
2035
  to access resources.
2036
2036
  """
2037
2037
 
2038
- def authorize(self, auth_header: str, authorize_request: "authorization_AuthorizationRequest") -> List[str]:
2038
+ def authorize(self, auth_header: str, request: "authorization_AuthorizationRequest") -> List[str]:
2039
2039
  """
2040
2040
  Given a set of resources, returns the set of resources that the
2041
- user is authorized to access, per their organization.
2041
+ user is authorized to access.
2042
2042
  """
2043
2043
 
2044
2044
  _headers: Dict[str, Any] = {
@@ -2053,7 +2053,7 @@ user is authorized to access, per their organization.
2053
2053
  _path_params: Dict[str, Any] = {
2054
2054
  }
2055
2055
 
2056
- _json: Any = ConjureEncoder().default(authorize_request)
2056
+ _json: Any = ConjureEncoder().default(request)
2057
2057
 
2058
2058
  _path = '/authorization/v1/authorize'
2059
2059
  _path = _path.format(**_path_params)
@@ -2101,6 +2101,41 @@ belongs to a different organization.
2101
2101
 
2102
2102
  return
2103
2103
 
2104
+ def register_in_workspace(self, auth_header: str, request: "authorization_RegisterInWorkspaceRequest") -> None:
2105
+ """
2106
+ Marks a set of resources as belonging to a workspace. Either all resources are
2107
+ registered or none are.
2108
+ If the user is not in the workspace, this will throw.
2109
+ If a resource already belongs to a different workspace, this will throw.
2110
+ If a resource already belongs to this workspace, this is a no-op.
2111
+ """
2112
+
2113
+ _headers: Dict[str, Any] = {
2114
+ 'Accept': 'application/json',
2115
+ 'Content-Type': 'application/json',
2116
+ 'Authorization': auth_header,
2117
+ }
2118
+
2119
+ _params: Dict[str, Any] = {
2120
+ }
2121
+
2122
+ _path_params: Dict[str, Any] = {
2123
+ }
2124
+
2125
+ _json: Any = ConjureEncoder().default(request)
2126
+
2127
+ _path = '/authorization/v1/register-in-workspace'
2128
+ _path = _path.format(**_path_params)
2129
+
2130
+ _response: Response = self._request(
2131
+ 'POST',
2132
+ self._uri + _path,
2133
+ params=_params,
2134
+ headers=_headers,
2135
+ json=_json)
2136
+
2137
+ return
2138
+
2104
2139
  def check_admin(self, auth_header: str) -> None:
2105
2140
  """
2106
2141
  Given an authenticated session, this endpoint returns a HTTP 204 if the
@@ -2661,6 +2696,35 @@ authorization_ListApiKeyResponse.__qualname__ = "ListApiKeyResponse"
2661
2696
  authorization_ListApiKeyResponse.__module__ = "nominal_api.authorization"
2662
2697
 
2663
2698
 
2699
+ class authorization_RegisterInWorkspaceRequest(ConjureBeanType):
2700
+
2701
+ @builtins.classmethod
2702
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
2703
+ return {
2704
+ 'resource_rids': ConjureFieldDefinition('resourceRids', List[str]),
2705
+ 'workspace_rid': ConjureFieldDefinition('workspaceRid', api_rids_WorkspaceRid)
2706
+ }
2707
+
2708
+ __slots__: List[str] = ['_resource_rids', '_workspace_rid']
2709
+
2710
+ def __init__(self, resource_rids: List[str], workspace_rid: str) -> None:
2711
+ self._resource_rids = resource_rids
2712
+ self._workspace_rid = workspace_rid
2713
+
2714
+ @builtins.property
2715
+ def resource_rids(self) -> List[str]:
2716
+ return self._resource_rids
2717
+
2718
+ @builtins.property
2719
+ def workspace_rid(self) -> str:
2720
+ return self._workspace_rid
2721
+
2722
+
2723
+ authorization_RegisterInWorkspaceRequest.__name__ = "RegisterInWorkspaceRequest"
2724
+ authorization_RegisterInWorkspaceRequest.__qualname__ = "RegisterInWorkspaceRequest"
2725
+ authorization_RegisterInWorkspaceRequest.__module__ = "nominal_api.authorization"
2726
+
2727
+
2664
2728
  class authorization_RegistrationRequest(ConjureBeanType):
2665
2729
 
2666
2730
  @builtins.classmethod
@@ -21936,6 +22000,28 @@ scout_checklistexecution_api_Failure.__qualname__ = "Failure"
21936
22000
  scout_checklistexecution_api_Failure.__module__ = "nominal_api.scout_checklistexecution_api"
21937
22001
 
21938
22002
 
22003
+ class scout_checklistexecution_api_InvalidStreamingComputeNode(ConjureEnumType):
22004
+
22005
+ POINT_PERSISTENCE = 'POINT_PERSISTENCE'
22006
+ '''POINT_PERSISTENCE'''
22007
+ CUMULATIVE_SUM = 'CUMULATIVE_SUM'
22008
+ '''CUMULATIVE_SUM'''
22009
+ INTEGRAL = 'INTEGRAL'
22010
+ '''INTEGRAL'''
22011
+ STALENESS_DETECTION = 'STALENESS_DETECTION'
22012
+ '''STALENESS_DETECTION'''
22013
+ UNKNOWN = 'UNKNOWN'
22014
+ '''UNKNOWN'''
22015
+
22016
+ def __reduce_ex__(self, proto):
22017
+ return self.__class__, (self.name,)
22018
+
22019
+
22020
+ scout_checklistexecution_api_InvalidStreamingComputeNode.__name__ = "InvalidStreamingComputeNode"
22021
+ scout_checklistexecution_api_InvalidStreamingComputeNode.__qualname__ = "InvalidStreamingComputeNode"
22022
+ scout_checklistexecution_api_InvalidStreamingComputeNode.__module__ = "nominal_api.scout_checklistexecution_api"
22023
+
22024
+
21939
22025
  class scout_checklistexecution_api_LastFailure(ConjureUnionType):
21940
22026
  _not_computed: Optional["scout_checklistexecution_api_NotComputed"] = None
21941
22027
  _computing: Optional["scout_checklistexecution_api_Computing"] = None
@@ -22281,7 +22367,7 @@ scout_checklistexecution_api_Pass.__module__ = "nominal_api.scout_checklistexecu
22281
22367
 
22282
22368
  class scout_checklistexecution_api_ResolvedCheckStatus(ConjureBeanType):
22283
22369
  """
22284
- Provides the resolution status for the required channels for a check.
22370
+ Provides the resolution status for the required channels for a check and the set of invalid streaming compute nodes present within the check's compute graph.
22285
22371
  Uniqueness between checkRid and checkParameterIndex pairs is guaranteed.
22286
22372
  checkParameterIndex is optional and will be null if the check is not parameterized otherwise it will be the index of the parameter.
22287
22373
  """
@@ -22291,14 +22377,16 @@ checkParameterIndex is optional and will be null if the check is not parameteriz
22291
22377
  return {
22292
22378
  'check_rid': ConjureFieldDefinition('checkRid', scout_rids_api_CheckRid),
22293
22379
  'check_parameter_index': ConjureFieldDefinition('checkParameterIndex', OptionalTypeWrapper[int]),
22380
+ 'invalid_streaming_compute_nodes': ConjureFieldDefinition('invalidStreamingComputeNodes', List[scout_checklistexecution_api_InvalidStreamingComputeNode]),
22294
22381
  'channels': ConjureFieldDefinition('channels', List[scout_checklistexecution_api_ChannelLocatorWithStatus])
22295
22382
  }
22296
22383
 
22297
- __slots__: List[str] = ['_check_rid', '_check_parameter_index', '_channels']
22384
+ __slots__: List[str] = ['_check_rid', '_check_parameter_index', '_invalid_streaming_compute_nodes', '_channels']
22298
22385
 
22299
- def __init__(self, channels: List["scout_checklistexecution_api_ChannelLocatorWithStatus"], check_rid: str, check_parameter_index: Optional[int] = None) -> None:
22386
+ def __init__(self, channels: List["scout_checklistexecution_api_ChannelLocatorWithStatus"], check_rid: str, invalid_streaming_compute_nodes: List["scout_checklistexecution_api_InvalidStreamingComputeNode"], check_parameter_index: Optional[int] = None) -> None:
22300
22387
  self._check_rid = check_rid
22301
22388
  self._check_parameter_index = check_parameter_index
22389
+ self._invalid_streaming_compute_nodes = invalid_streaming_compute_nodes
22302
22390
  self._channels = channels
22303
22391
 
22304
22392
  @builtins.property
@@ -22309,6 +22397,10 @@ checkParameterIndex is optional and will be null if the check is not parameteriz
22309
22397
  def check_parameter_index(self) -> Optional[int]:
22310
22398
  return self._check_parameter_index
22311
22399
 
22400
+ @builtins.property
22401
+ def invalid_streaming_compute_nodes(self) -> List["scout_checklistexecution_api_InvalidStreamingComputeNode"]:
22402
+ return self._invalid_streaming_compute_nodes
22403
+
22312
22404
  @builtins.property
22313
22405
  def channels(self) -> List["scout_checklistexecution_api_ChannelLocatorWithStatus"]:
22314
22406
  return self._channels
@@ -22378,24 +22470,34 @@ scout_checklistexecution_api_StreamingChecklistInfo.__module__ = "nominal_api.sc
22378
22470
 
22379
22471
 
22380
22472
  class scout_checklistexecution_api_ValidateChecklistResolutionRequest(ConjureBeanType):
22473
+ """
22474
+ Validates that the channels referenced by the checklist can be resolved against the data sources.
22475
+ If commit is not provided, the latest commit on main will be used.
22476
+ """
22381
22477
 
22382
22478
  @builtins.classmethod
22383
22479
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
22384
22480
  return {
22385
22481
  'checklist_rid': ConjureFieldDefinition('checklistRid', scout_rids_api_ChecklistRid),
22482
+ 'commit_id': ConjureFieldDefinition('commitId', OptionalTypeWrapper[scout_versioning_api_CommitId]),
22386
22483
  'asset_rid': ConjureFieldDefinition('assetRid', scout_rids_api_AssetRid)
22387
22484
  }
22388
22485
 
22389
- __slots__: List[str] = ['_checklist_rid', '_asset_rid']
22486
+ __slots__: List[str] = ['_checklist_rid', '_commit_id', '_asset_rid']
22390
22487
 
22391
- def __init__(self, asset_rid: str, checklist_rid: str) -> None:
22488
+ def __init__(self, asset_rid: str, checklist_rid: str, commit_id: Optional[str] = None) -> None:
22392
22489
  self._checklist_rid = checklist_rid
22490
+ self._commit_id = commit_id
22393
22491
  self._asset_rid = asset_rid
22394
22492
 
22395
22493
  @builtins.property
22396
22494
  def checklist_rid(self) -> str:
22397
22495
  return self._checklist_rid
22398
22496
 
22497
+ @builtins.property
22498
+ def commit_id(self) -> Optional[str]:
22499
+ return self._commit_id
22500
+
22399
22501
  @builtins.property
22400
22502
  def asset_rid(self) -> str:
22401
22503
  return self._asset_rid
@@ -14,6 +14,7 @@ from .._impl import (
14
14
  authorization_IsEmailAllowedResponse as IsEmailAllowedResponse,
15
15
  authorization_ListApiKeyRequest as ListApiKeyRequest,
16
16
  authorization_ListApiKeyResponse as ListApiKeyResponse,
17
+ authorization_RegisterInWorkspaceRequest as RegisterInWorkspaceRequest,
17
18
  authorization_RegistrationRequest as RegistrationRequest,
18
19
  )
19
20
 
@@ -22,6 +22,7 @@ from .._impl import (
22
22
  scout_checklistexecution_api_Fail as Fail,
23
23
  scout_checklistexecution_api_FailedToResolve as FailedToResolve,
24
24
  scout_checklistexecution_api_Failure as Failure,
25
+ scout_checklistexecution_api_InvalidStreamingComputeNode as InvalidStreamingComputeNode,
25
26
  scout_checklistexecution_api_LastFailure as LastFailure,
26
27
  scout_checklistexecution_api_LastFailureVisitor as LastFailureVisitor,
27
28
  scout_checklistexecution_api_ListStreamingChecklistForAssetRequest as ListStreamingChecklistForAssetRequest,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: nominal-api
3
- Version: 0.585.0
3
+ Version: 0.586.1
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -1,12 +1,12 @@
1
- nominal_api/__init__.py,sha256=uwBMps5HUsWZpppmK3si-cWjz0BL-sMxvLGPrgnyaxY,1938
2
- nominal_api/_impl.py,sha256=bcRUJ9Y-0l2FNxcCkvPA1Ropna-BlipXST0yaqwrnoQ,2828255
1
+ nominal_api/__init__.py,sha256=QYbjGA5NgMGPqltSMUBtP7yPwJOiXkQXFuh_9wAAF_o,1938
2
+ nominal_api/_impl.py,sha256=j01k6ClJn8Dof3OXbnT_Umzvga3l-K1G2-oEBraNgoI,2832239
3
3
  nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
4
4
  nominal_api/api/__init__.py,sha256=kJBEE_HLVpKYdLH12KyO-cSAVzwxYpBwaaDutCtT-LM,1236
5
5
  nominal_api/api_ids/__init__.py,sha256=CAtt44XgNZEEUDv-BbEbYtuxQ8y1wqSZU-STjBYdZv8,80
6
6
  nominal_api/api_rids/__init__.py,sha256=Bu-pKUh3aS9_f5m-DZf6W_BUlVo9qYE7EDvaT-rvWQ0,423
7
7
  nominal_api/attachments_api/__init__.py,sha256=eQBE8xVTFDaTItCZv-WJSZqSStpgdai192n23pmVeeQ,634
8
8
  nominal_api/authentication_api/__init__.py,sha256=HBQrldagoqcvYES_kjB1Eh8oZTZ8SJdX85UZySJB9z0,986
9
- nominal_api/authorization/__init__.py,sha256=dCAUHfh4BMgGp4RW0-2b_Xrtfz5BDcljwRVaShKhFI4,972
9
+ nominal_api/authorization/__init__.py,sha256=nOLO0xN9ilGeHRIlxsDPkrYH8BxDtoT8GkbuTbEUsL8,1048
10
10
  nominal_api/comments_api/__init__.py,sha256=bt24EdmTY513nKMrWMCsfYV0XmX7VKQgOFH4I4tKWy4,860
11
11
  nominal_api/connect_download/__init__.py,sha256=kYpjIjuFHA3uix70bJ5gV9-7BmDcJZAcm_e3MeMVSSQ,83
12
12
  nominal_api/datasource/__init__.py,sha256=C2lvxiWYnZRjaMKL2sY9_bfgZezBpK39A3VtgSASgRI,134
@@ -24,7 +24,7 @@ nominal_api/scout_catalog/__init__.py,sha256=ZGm4w1YKd4B-3CNxijTpB-1B653nctA_R0u
24
24
  nominal_api/scout_channelvariables_api/__init__.py,sha256=4OQV1O-M2MQE36yCGlyYftnqaXSddYTYTyGce_WC4JQ,466
25
25
  nominal_api/scout_chart_api/__init__.py,sha256=sw7WSYs6SarSW7x-3IBkSIrVea1cVFnQnpYiNKbCWnQ,184
26
26
  nominal_api/scout_chartdefinition_api/__init__.py,sha256=hUNlgtbvzeScfevv4tJKtb-CkHjvsp97SjdeoNuBI_0,8954
27
- nominal_api/scout_checklistexecution_api/__init__.py,sha256=FPiuWjrlG5wLVbd7KE7MKe12q-vpJuse9SnWezHQ5TQ,3173
27
+ nominal_api/scout_checklistexecution_api/__init__.py,sha256=lpBtfyRP-ReEwNzFTcynDgiMe8ahtEJb75pg7cKl-Q0,3266
28
28
  nominal_api/scout_checks_api/__init__.py,sha256=RJH7HsXjUhItC11V9C-hfv6lkIfiSXyxnB8slUpaT2g,5203
29
29
  nominal_api/scout_comparisonnotebook_api/__init__.py,sha256=8BL5jE9NDxqCj9DyvZWSPhq6zw2J7xp6aLsl3x9rpyw,4530
30
30
  nominal_api/scout_comparisonrun_api/__init__.py,sha256=1LCXQe64tDqqeMQixW8PI-R_edSz7F5X0x2_ufEuC8M,480
@@ -71,7 +71,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=7NlQhIzOKOcjwMNUI89f
71
71
  nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
72
72
  nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
73
73
  nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
74
- nominal_api-0.585.0.dist-info/METADATA,sha256=TPfNe-lVtHkfi3l9aiiwVOebohNhdL9aY97mQQRZE64,199
75
- nominal_api-0.585.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
76
- nominal_api-0.585.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
77
- nominal_api-0.585.0.dist-info/RECORD,,
74
+ nominal_api-0.586.1.dist-info/METADATA,sha256=BtTaEYuVRFVZLXGCqlRMdrHYLnBbVKYtUZzUds5cMkE,199
75
+ nominal_api-0.586.1.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
76
+ nominal_api-0.586.1.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
77
+ nominal_api-0.586.1.dist-info/RECORD,,