nominal-api 0.588.0__tar.gz → 0.589.0__tar.gz

{nominal_api-0.588.0 → nominal_api-0.589.0}/PKG-INFO

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

{nominal_api-0.588.0 → nominal_api-0.589.0}/nominal_api/__init__.py

@@ -74,5 +74,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.588.0"
+__version__ = "0.589.0"
 

{nominal_api-0.588.0 → nominal_api-0.589.0}/nominal_api/_impl.py

@@ -2068,6 +2068,40 @@ user is authorized to access.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), List[str], self._return_none_for_unknown_union_types)
 
+    def batch_get_workspace_for_resource(self, auth_header: str, request: List[str] = None) -> Dict[str, str]:
+        """
+        Given a set of resources, returns the workspace that each resource belongs to. If a user
+is not authorized on the resource, will omit the resource from the response.
+        """
+        request = request if request is not None else []
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/authorization/v1/batch-get-workspace-for-resource'
+        _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(), Dict[str, api_rids_WorkspaceRid], self._return_none_for_unknown_union_types)
+
     def register(self, auth_header: str, register_request: "authorization_RegistrationRequest") -> None:
         """
         Marks a resource as belonging to an organization.
@@ -4842,16 +4876,18 @@ class datasource_logset_api_CreateLogSetRequest(ConjureBeanType):
             'name': ConjureFieldDefinition('name', str),
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
             'origin_metadata': ConjureFieldDefinition('originMetadata', Dict[str, str]),
-            'timestamp_type': ConjureFieldDefinition('timestampType', datasource_TimestampType)
+            'timestamp_type': ConjureFieldDefinition('timestampType', datasource_TimestampType),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_name', '_description', '_origin_metadata', '_timestamp_type']
+    __slots__: List[str] = ['_name', '_description', '_origin_metadata', '_timestamp_type', '_workspace']
 
-    def __init__(self, name: str, origin_metadata: Dict[str, str], timestamp_type: "datasource_TimestampType", description: Optional[str] = None) -> None:
+    def __init__(self, name: str, origin_metadata: Dict[str, str], timestamp_type: "datasource_TimestampType", description: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._name = name
         self._description = description
         self._origin_metadata = origin_metadata
         self._timestamp_type = timestamp_type
+        self._workspace = workspace
 
     @builtins.property
     def name(self) -> str:
@@ -4869,6 +4905,14 @@ class datasource_logset_api_CreateLogSetRequest(ConjureBeanType):
     def timestamp_type(self) -> "datasource_TimestampType":
         return self._timestamp_type
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the logset. If not provided, the logset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 datasource_logset_api_CreateLogSetRequest.__name__ = "CreateLogSetRequest"
 datasource_logset_api_CreateLogSetRequest.__qualname__ = "CreateLogSetRequest"
@@ -5138,14 +5182,16 @@ class datasource_logset_api_SearchLogSetsRequest(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'token': ConjureFieldDefinition('token', OptionalTypeWrapper[api_Token]),
-            'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int])
+            'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
+            'workspaces': ConjureFieldDefinition('workspaces', List[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_token', '_page_size']
+    __slots__: List[str] = ['_token', '_page_size', '_workspaces']
 
-    def __init__(self, page_size: Optional[int] = None, token: Optional[str] = None) -> None:
+    def __init__(self, workspaces: List[str], page_size: Optional[int] = None, token: Optional[str] = None) -> None:
         self._token = token
         self._page_size = page_size
+        self._workspaces = workspaces
 
     @builtins.property
     def token(self) -> Optional[str]:
@@ -5158,6 +5204,14 @@ class datasource_logset_api_SearchLogSetsRequest(ConjureBeanType):
         """
         return self._page_size
 
+    @builtins.property
+    def workspaces(self) -> List[str]:
+        """
+        If supplied, will return only the log sets within the supplied workspaces. If empty
+will return all connections for workspaces that the user is permitted to see.
+        """
+        return self._workspaces
+
 
 datasource_logset_api_SearchLogSetsRequest.__name__ = "SearchLogSetsRequest"
 datasource_logset_api_SearchLogSetsRequest.__qualname__ = "SearchLogSetsRequest"
@@ -17972,6 +18026,27 @@ scout_chartdefinition_api_FrequencyPlot.__qualname__ = "FrequencyPlot"
 scout_chartdefinition_api_FrequencyPlot.__module__ = "nominal_api.scout_chartdefinition_api"
 
 
+class scout_chartdefinition_api_GeoAdditionalTileset(ConjureEnumType):
+    """
+    A standard tileset to overlay on the base map.
+    """
+
+    VFR = 'VFR'
+    '''VFR'''
+    BATHYMETRY = 'BATHYMETRY'
+    '''BATHYMETRY'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_chartdefinition_api_GeoAdditionalTileset.__name__ = "GeoAdditionalTileset"
+scout_chartdefinition_api_GeoAdditionalTileset.__qualname__ = "GeoAdditionalTileset"
+scout_chartdefinition_api_GeoAdditionalTileset.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
 class scout_chartdefinition_api_GeoAdditionalVariable(ConjureBeanType):
 
     @builtins.classmethod
@@ -18379,15 +18454,17 @@ class scout_chartdefinition_api_GeoVizDefinitionV1(ConjureBeanType):
         return {
             'plots': ConjureFieldDefinition('plots', List[scout_chartdefinition_api_GeoPlotFromLatLong]),
             'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
-            'custom_features': ConjureFieldDefinition('customFeatures', List[scout_chartdefinition_api_GeoCustomFeature])
+            'custom_features': ConjureFieldDefinition('customFeatures', List[scout_chartdefinition_api_GeoCustomFeature]),
+            'additional_tileset': ConjureFieldDefinition('additionalTileset', OptionalTypeWrapper[scout_chartdefinition_api_GeoAdditionalTileset])
         }
 
-    __slots__: List[str] = ['_plots', '_title', '_custom_features']
+    __slots__: List[str] = ['_plots', '_title', '_custom_features', '_additional_tileset']
 
-    def __init__(self, custom_features: List["scout_chartdefinition_api_GeoCustomFeature"], plots: List["scout_chartdefinition_api_GeoPlotFromLatLong"], title: Optional[str] = None) -> None:
+    def __init__(self, custom_features: List["scout_chartdefinition_api_GeoCustomFeature"], plots: List["scout_chartdefinition_api_GeoPlotFromLatLong"], additional_tileset: Optional["scout_chartdefinition_api_GeoAdditionalTileset"] = None, title: Optional[str] = None) -> None:
         self._plots = plots
         self._title = title
         self._custom_features = custom_features
+        self._additional_tileset = additional_tileset
 
     @builtins.property
     def plots(self) -> List["scout_chartdefinition_api_GeoPlotFromLatLong"]:
@@ -18401,6 +18478,10 @@ class scout_chartdefinition_api_GeoVizDefinitionV1(ConjureBeanType):
     def custom_features(self) -> List["scout_chartdefinition_api_GeoCustomFeature"]:
         return self._custom_features
 
+    @builtins.property
+    def additional_tileset(self) -> Optional["scout_chartdefinition_api_GeoAdditionalTileset"]:
+        return self._additional_tileset
+
 
 scout_chartdefinition_api_GeoVizDefinitionV1.__name__ = "GeoVizDefinitionV1"
 scout_chartdefinition_api_GeoVizDefinitionV1.__qualname__ = "GeoVizDefinitionV1"
@@ -53341,10 +53422,11 @@ The Connection Service is responsible for creating, updating, and retrieving dat
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), List[scout_datasource_connection_api_Connection], self._return_none_for_unknown_union_types)
 
-    def list_connections(self, auth_header: str, include_archived: Optional[bool] = None) -> List["scout_datasource_connection_api_Connection"]:
+    def list_connections(self, auth_header: str, workspaces: List[str] = None, include_archived: Optional[bool] = None) -> List["scout_datasource_connection_api_Connection"]:
         """
         Lists all connections.
         """
+        workspaces = workspaces if workspaces is not None else []
 
         _headers: Dict[str, Any] = {
             'Accept': 'application/json',
@@ -53353,6 +53435,7 @@ The Connection Service is responsible for creating, updating, and retrieving dat
 
         _params: Dict[str, Any] = {
             'includeArchived': include_archived,
+            'workspaces': workspaces,
         }
 
         _path_params: Dict[str, Any] = {
@@ -53985,12 +54068,13 @@ class scout_datasource_connection_api_CreateConnection(ConjureBeanType):
             'available_tag_values': ConjureFieldDefinition('availableTagValues', Dict[api_TagName, List[api_TagValue]]),
             'scraping': ConjureFieldDefinition('scraping', OptionalTypeWrapper[scout_datasource_connection_api_ScrapingConfig]),
             'should_scrape': ConjureFieldDefinition('shouldScrape', bool),
-            'limits': ConjureFieldDefinition('limits', OptionalTypeWrapper[scout_datasource_connection_api_LimitsConfig])
+            'limits': ConjureFieldDefinition('limits', OptionalTypeWrapper[scout_datasource_connection_api_LimitsConfig]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_name', '_description', '_connection_details', '_metadata', '_required_tag_names', '_available_tag_values', '_scraping', '_should_scrape', '_limits']
+    __slots__: List[str] = ['_name', '_description', '_connection_details', '_metadata', '_required_tag_names', '_available_tag_values', '_scraping', '_should_scrape', '_limits', '_workspace']
 
-    def __init__(self, available_tag_values: Dict[str, List[str]], connection_details: "scout_datasource_connection_api_ConnectionDetails", metadata: Dict[str, str], name: str, required_tag_names: List[str], should_scrape: bool, description: Optional[str] = None, limits: Optional["scout_datasource_connection_api_LimitsConfig"] = None, scraping: Optional["scout_datasource_connection_api_ScrapingConfig"] = None) -> None:
+    def __init__(self, available_tag_values: Dict[str, List[str]], connection_details: "scout_datasource_connection_api_ConnectionDetails", metadata: Dict[str, str], name: str, required_tag_names: List[str], should_scrape: bool, description: Optional[str] = None, limits: Optional["scout_datasource_connection_api_LimitsConfig"] = None, scraping: Optional["scout_datasource_connection_api_ScrapingConfig"] = None, workspace: Optional[str] = None) -> None:
         self._name = name
         self._description = description
         self._connection_details = connection_details
@@ -54000,6 +54084,7 @@ class scout_datasource_connection_api_CreateConnection(ConjureBeanType):
         self._scraping = scraping
         self._should_scrape = should_scrape
         self._limits = limits
+        self._workspace = workspace
 
     @builtins.property
     def name(self) -> str:
@@ -54043,6 +54128,14 @@ class scout_datasource_connection_api_CreateConnection(ConjureBeanType):
     def limits(self) -> Optional["scout_datasource_connection_api_LimitsConfig"]:
         return self._limits
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the connection. If not provided, the connection will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 scout_datasource_connection_api_CreateConnection.__name__ = "CreateConnection"
 scout_datasource_connection_api_CreateConnection.__qualname__ = "CreateConnection"

{nominal_api-0.588.0 → nominal_api-0.589.0}/nominal_api/scout_chartdefinition_api/__init__.py

@@ -29,6 +29,7 @@ from .._impl import (
     scout_chartdefinition_api_FrequencyChartDefinitionV1 as FrequencyChartDefinitionV1,
     scout_chartdefinition_api_FrequencyChartDefinitionVisitor as FrequencyChartDefinitionVisitor,
     scout_chartdefinition_api_FrequencyPlot as FrequencyPlot,
+    scout_chartdefinition_api_GeoAdditionalTileset as GeoAdditionalTileset,
     scout_chartdefinition_api_GeoAdditionalVariable as GeoAdditionalVariable,
     scout_chartdefinition_api_GeoCustomFeature as GeoCustomFeature,
     scout_chartdefinition_api_GeoCustomFeatureVisitor as GeoCustomFeatureVisitor,

{nominal_api-0.588.0 → nominal_api-0.589.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.588.0 → nominal_api-0.589.0}/setup.py

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