nominal-api 0.648.0__py3-none-any.whl → 0.649.0__py3-none-any.whl

nominal_api/__init__.py

@@ -76,5 +76,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.648.0"
+__version__ = "0.649.0"
 

nominal_api/_impl.py

@@ -445,16 +445,18 @@ results to clients as part of a response object when directly throwing an except
             'name': ConjureFieldDefinition('name', str),
             'message': ConjureFieldDefinition('message', OptionalTypeWrapper[str]),
             'error_instance_id': ConjureFieldDefinition('errorInstanceId', str),
-            'status_code': ConjureFieldDefinition('statusCode', int)
+            'status_code': ConjureFieldDefinition('statusCode', int),
+            'params': ConjureFieldDefinition('params', Dict[str, str])
         }
 
-    __slots__: List[str] = ['_name', '_message', '_error_instance_id', '_status_code']
+    __slots__: List[str] = ['_name', '_message', '_error_instance_id', '_status_code', '_params']
 
-    def __init__(self, error_instance_id: str, name: str, status_code: int, message: Optional[str] = None) -> None:
+    def __init__(self, error_instance_id: str, name: str, params: Dict[str, str], status_code: int, message: Optional[str] = None) -> None:
         self._name = name
         self._message = message
         self._error_instance_id = error_instance_id
         self._status_code = status_code
+        self._params = params
 
     @builtins.property
     def name(self) -> str:
@@ -472,6 +474,10 @@ results to clients as part of a response object when directly throwing an except
     def status_code(self) -> int:
         return self._status_code
 
+    @builtins.property
+    def params(self) -> Dict[str, str]:
+        return self._params
+
 
 api_SerializableError.__name__ = "SerializableError"
 api_SerializableError.__qualname__ = "SerializableError"
@@ -13672,6 +13678,71 @@ a RunNotFound error will be thrown.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), scout_notebook_api_NotebookMetadata, self._return_none_for_unknown_union_types)
 
+    def get_used_ref_names(self, auth_header: str, rid: str) -> List[str]:
+        """
+        Returns the set of all ref names used by the workbook.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+            'rid': rid,
+        }
+
+        _json: Any = None
+
+        _path = '/scout/v2/notebook/{rid}/ref-names'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'GET',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), List[scout_api_DataSourceRefName], self._return_none_for_unknown_union_types)
+
+    def update_ref_names(self, auth_header: str, request: "scout_notebook_api_UpdateRefNameRequest", rid: str) -> "scout_notebook_api_Notebook":
+        """
+        Updates the data source ref names for all variables used in the workbook.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+            'rid': rid,
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/scout/v2/notebook/{rid}/update-ref-names'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), scout_notebook_api_Notebook, self._return_none_for_unknown_union_types)
+
     def get_all_labels_and_properties(self, auth_header: str, workspaces: List[str] = None) -> "scout_notebook_api_GetAllLabelsAndPropertiesResponse":
         """
         Returns all properties (key value pairs) and labels that have been previously used on workbook. These can
@@ -14665,6 +14736,74 @@ Throws if you save to an archived template.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), scout_template_api_Template, self._return_none_for_unknown_union_types)
 
+    def get_used_ref_names(self, auth_header: str, template_rid: str, branch: Optional[str] = None, commit: Optional[str] = None) -> List[str]:
+        """
+        Returns the set of all ref names used by the template.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+            'branch': branch,
+            'commit': commit,
+        }
+
+        _path_params: Dict[str, Any] = {
+            'templateRid': template_rid,
+        }
+
+        _json: Any = None
+
+        _path = '/scout/v1/template/{templateRid}/ref-names'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'GET',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), List[scout_api_DataSourceRefName], self._return_none_for_unknown_union_types)
+
+    def update_ref_names(self, auth_header: str, request: "scout_template_api_UpdateRefNameRequest", template_rid: str, branch: Optional[str] = None) -> "scout_template_api_Template":
+        """
+        Updates the data source ref names for all variables used in the template.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+            'branch': branch,
+        }
+
+        _path_params: Dict[str, Any] = {
+            'templateRid': template_rid,
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/scout/v1/template/{templateRid}/update-ref-names'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), scout_template_api_Template, self._return_none_for_unknown_union_types)
+
     def commit(self, auth_header: str, request: "scout_template_api_CommitTemplateRequest", template_rid: str, branch: Optional[str] = None) -> "scout_template_api_Template":
         """
         Creates a commit with a commit message. 
@@ -37035,20 +37174,10 @@ class scout_compute_api_ExponentialCurve(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'intercept': ConjureFieldDefinition('intercept', OptionalTypeWrapper[scout_compute_api_DoubleConstant])
         }
 
-    __slots__: List[str] = ['_intercept']
-
-    def __init__(self, intercept: Optional["scout_compute_api_DoubleConstant"] = None) -> None:
-        self._intercept = intercept
+    __slots__: List[str] = []
 
-    @builtins.property
-    def intercept(self) -> Optional["scout_compute_api_DoubleConstant"]:
-        """
-        The y-value at the point x (or t) = 0. If omitted, the y-intercept will also be fit to the data.
-        """
-        return self._intercept
 
 
 scout_compute_api_ExponentialCurve.__name__ = "ExponentialCurve"
@@ -49220,17 +49349,10 @@ class scout_compute_resolved_api_ExponentialCurve(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'intercept': ConjureFieldDefinition('intercept', OptionalTypeWrapper[float])
         }
 
-    __slots__: List[str] = ['_intercept']
+    __slots__: List[str] = []
 
-    def __init__(self, intercept: Optional[float] = None) -> None:
-        self._intercept = intercept
-
-    @builtins.property
-    def intercept(self) -> Optional[float]:
-        return self._intercept
 
 
 scout_compute_resolved_api_ExponentialCurve.__name__ = "ExponentialCurve"
@@ -65484,6 +65606,29 @@ scout_notebook_api_UpdateNotebookRequest.__qualname__ = "UpdateNotebookRequest"
 scout_notebook_api_UpdateNotebookRequest.__module__ = "nominal_api.scout_notebook_api"
 
 
+class scout_notebook_api_UpdateRefNameRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'ref_name_updates': ConjureFieldDefinition('refNameUpdates', Dict[scout_api_DataSourceRefName, scout_api_DataSourceRefName])
+        }
+
+    __slots__: List[str] = ['_ref_name_updates']
+
+    def __init__(self, ref_name_updates: Dict[str, str]) -> None:
+        self._ref_name_updates = ref_name_updates
+
+    @builtins.property
+    def ref_name_updates(self) -> Dict[str, str]:
+        return self._ref_name_updates
+
+
+scout_notebook_api_UpdateRefNameRequest.__name__ = "UpdateRefNameRequest"
+scout_notebook_api_UpdateRefNameRequest.__qualname__ = "UpdateRefNameRequest"
+scout_notebook_api_UpdateRefNameRequest.__module__ = "nominal_api.scout_notebook_api"
+
+
 class scout_plotting_TimestampType(ConjureEnumType):
 
     ABSOLUTE = 'ABSOLUTE'
@@ -68519,6 +68664,39 @@ scout_template_api_UpdateMetadataRequest.__qualname__ = "UpdateMetadataRequest"
 scout_template_api_UpdateMetadataRequest.__module__ = "nominal_api.scout_template_api"
 
 
+class scout_template_api_UpdateRefNameRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'ref_name_updates': ConjureFieldDefinition('refNameUpdates', Dict[scout_api_DataSourceRefName, scout_api_DataSourceRefName]),
+            'latest_commit': ConjureFieldDefinition('latestCommit', OptionalTypeWrapper[scout_versioning_api_CommitId])
+        }
+
+    __slots__: List[str] = ['_ref_name_updates', '_latest_commit']
+
+    def __init__(self, ref_name_updates: Dict[str, str], latest_commit: Optional[str] = None) -> None:
+        self._ref_name_updates = ref_name_updates
+        self._latest_commit = latest_commit
+
+    @builtins.property
+    def ref_name_updates(self) -> Dict[str, str]:
+        return self._ref_name_updates
+
+    @builtins.property
+    def latest_commit(self) -> Optional[str]:
+        """
+        If present, will validate that the latest commit matches this id,
+and otherwise throw CommitConflict.
+        """
+        return self._latest_commit
+
+
+scout_template_api_UpdateRefNameRequest.__name__ = "UpdateRefNameRequest"
+scout_template_api_UpdateRefNameRequest.__qualname__ = "UpdateRefNameRequest"
+scout_template_api_UpdateRefNameRequest.__module__ = "nominal_api.scout_template_api"
+
+
 class scout_units_api_GetUnitsResponse(ConjureBeanType):
 
     @builtins.classmethod
@@ -73700,8 +73878,9 @@ Nominal live within a workspace.
 
     def get_default_workspace(self, auth_header: str) -> Optional["security_api_workspace_Workspace"]:
         """
-        Gets the default workspace for the requesting user. It may not be present if the user does not have
-access to any workspaces or no default workspace is configured for the user's organization.
+        Gets the default workspace for the requesting user. If the user belongs to a single workspace,
+that workspace is returned. Otherwise, if the user's organization has a default workspace and
+the user belongs to it, that will be returned.
         """
 
         _headers: Dict[str, Any] = {

nominal_api/scout_notebook_api/__init__.py

@@ -18,5 +18,6 @@ from .._impl import (
     scout_notebook_api_SortByField as SortByField,
     scout_notebook_api_UpdateNotebookMetadataRequest as UpdateNotebookMetadataRequest,
     scout_notebook_api_UpdateNotebookRequest as UpdateNotebookRequest,
+    scout_notebook_api_UpdateRefNameRequest as UpdateRefNameRequest,
 )
 

nominal_api/scout_template_api/__init__.py

@@ -15,5 +15,6 @@ from .._impl import (
     scout_template_api_TemplateMetadata as TemplateMetadata,
     scout_template_api_TemplateSummary as TemplateSummary,
     scout_template_api_UpdateMetadataRequest as UpdateMetadataRequest,
+    scout_template_api_UpdateRefNameRequest as UpdateRefNameRequest,
 )
 

{nominal_api-0.648.0.dist-info → nominal_api-0.649.0.dist-info}/METADATA

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

{nominal_api-0.648.0.dist-info → nominal_api-0.649.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=UyIsaXjtJzowGOZDSBrr5mvJIwOAyFaVsnJf-zEPv2M,1995
-nominal_api/_impl.py,sha256=fEbMKHOIzTdVyoP9HfEERDmfiwa8ZnGZskAoCyIrXHQ,3093123
+nominal_api/__init__.py,sha256=AWDyeJUw_rsShD4lxNqPRxzhiq5uBq3jdCr1aWTjZDs,1995
+nominal_api/_impl.py,sha256=R6iq_51KzT5jQuDGtL_j00Ph6HEe_oWUOxp16MMw888,3098833
 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
@@ -47,11 +47,11 @@ nominal_api/scout_internal_search_api/__init__.py,sha256=CF2YYZXkl95YkEgCbhqXSdA
 nominal_api/scout_jobs_api/__init__.py,sha256=_2ETRUShk1pestGAKzHwc69S-ililQRD4Y9JLD5qqZ4,146
 nominal_api/scout_layout_api/__init__.py,sha256=mKszV44ni9VODK9jFyY3O9YOV9DYltKJ20s91922EKc,1363
 nominal_api/scout_metadata/__init__.py,sha256=GIhWKJL2XSMB0iGaKfcGgmPHuvGWWmkK4lXSa1YsB44,332
-nominal_api/scout_notebook_api/__init__.py,sha256=QW0vg8ZrAmuctjnNLxTnqtwyQoX-H9MOkHlLWioe5AA,1230
+nominal_api/scout_notebook_api/__init__.py,sha256=TW4_Y2DbakA13v3q_vmRSN8gaS8g0UYRREVKruujJc0,1299
 nominal_api/scout_plotting/__init__.py,sha256=m6u3y7R70mo3ugaCp_-fwlS8_tDwrsq1l5ElOTY0TBc,91
 nominal_api/scout_rids_api/__init__.py,sha256=zAioy5BpuLLgZQpF-11wWUEhntcHNj6sK5YzNC5z-3w,1188
 nominal_api/scout_run_api/__init__.py,sha256=lTAFwaHSqRs7dx316MzdQcgdBy7Y_fe_BbfbaktaZGs,2596
-nominal_api/scout_template_api/__init__.py,sha256=bsu8qPiZ4gf67G5iFvwsfkqEKJRZ7L5Wyg6qcFyogO0,1037
+nominal_api/scout_template_api/__init__.py,sha256=twrd03oixkoGnRn_xpXywTcdq2tvMD1PLxSrMPdwz9c,1106
 nominal_api/scout_units_api/__init__.py,sha256=KxRDScfumX__0ncWJftGvgApn_LBTfnIBAvnaBrcA5A,368
 nominal_api/scout_versioning_api/__init__.py,sha256=Sf4T4t0rZXNRIZgkqLBN3yh0sAnrxiuzaTfDQVVkyO4,1323
 nominal_api/scout_video/__init__.py,sha256=zB7mM23yGAgC529rF4gjDmqcLRbsp0kJA3xef8meZko,200
@@ -73,7 +73,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.648.0.dist-info/METADATA,sha256=3zganmhOd34ybiAGMBgc7VBym6A4kLuqTlLuioYbWgA,199
-nominal_api-0.648.0.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-nominal_api-0.648.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.648.0.dist-info/RECORD,,
+nominal_api-0.649.0.dist-info/METADATA,sha256=fVreTxzmDeS4abZzedg5tbLGGav54aoZXE9r4JDT3t0,199
+nominal_api-0.649.0.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+nominal_api-0.649.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.649.0.dist-info/RECORD,,