nominal-api 0.622.3__tar.gz → 0.624.0__tar.gz

{nominal_api-0.622.3 → nominal_api-0.624.0}/PKG-INFO

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

{nominal_api-0.622.3 → nominal_api-0.624.0}/nominal_api/__init__.py

@@ -76,5 +76,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.622.3"
+__version__ = "0.624.0"
 

{nominal_api-0.622.3 → nominal_api-0.624.0}/nominal_api/_impl.py

@@ -404,6 +404,35 @@ api_Property.__qualname__ = "Property"
 api_Property.__module__ = "nominal_api.api"
 
 
+class api_Range(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'start': ConjureFieldDefinition('start', api_Timestamp),
+            'end': ConjureFieldDefinition('end', api_Timestamp)
+        }
+
+    __slots__: List[str] = ['_start', '_end']
+
+    def __init__(self, end: "api_Timestamp", start: "api_Timestamp") -> None:
+        self._start = start
+        self._end = end
+
+    @builtins.property
+    def start(self) -> "api_Timestamp":
+        return self._start
+
+    @builtins.property
+    def end(self) -> "api_Timestamp":
+        return self._end
+
+
+api_Range.__name__ = "Range"
+api_Range.__qualname__ = "Range"
+api_Range.__module__ = "nominal_api.api"
+
+
 class api_SerializableError(ConjureBeanType):
     """
     A SerializableError is a representation of a ServiceException that exists to send error
@@ -4345,6 +4374,40 @@ datasource_api_GetDataScopeBoundsResponse.__qualname__ = "GetDataScopeBoundsResp
 datasource_api_GetDataScopeBoundsResponse.__module__ = "nominal_api.datasource_api"
 
 
+class datasource_api_GetTagValuesForDataSourceRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'tag_keys': ConjureFieldDefinition('tagKeys', List[api_TagName]),
+            'range': ConjureFieldDefinition('range', OptionalTypeWrapper[api_Range])
+        }
+
+    __slots__: List[str] = ['_tag_keys', '_range']
+
+    def __init__(self, tag_keys: List[str], range: Optional["api_Range"] = None) -> None:
+        self._tag_keys = tag_keys
+        self._range = range
+
+    @builtins.property
+    def tag_keys(self) -> List[str]:
+        return self._tag_keys
+
+    @builtins.property
+    def range(self) -> Optional["api_Range"]:
+        """
+        For Nominal data sources, a time range can be provided to filter tag values to those present within the 
+months spanned by the range. If left empty, this defaults to the last month. For external data sources, 
+the range must not be specified, as all tag values are returned.
+        """
+        return self._range
+
+
+datasource_api_GetTagValuesForDataSourceRequest.__name__ = "GetTagValuesForDataSourceRequest"
+datasource_api_GetTagValuesForDataSourceRequest.__qualname__ = "GetTagValuesForDataSourceRequest"
+datasource_api_GetTagValuesForDataSourceRequest.__module__ = "nominal_api.datasource_api"
+
+
 class datasource_api_IndexChannelPrefixTreeRequest(ConjureBeanType):
 
     @builtins.classmethod
@@ -56461,6 +56524,42 @@ in the same order as requests.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), datasource_api_BatchGetDataScopeBoundsResponse, self._return_none_for_unknown_union_types)
 
+    def get_tag_values_for_data_source(self, auth_header: str, data_source_rid: str, request: "datasource_api_GetTagValuesForDataSourceRequest") -> Dict[str, List[str]]:
+        """
+        Returns available tag values for a given data source for a set of tag keys. For Nominal data sources, a time 
+range can be provided to filter tag values to those present within the months spanned by the range. If no
+time range is provided, this defaults to the last month. For external data sources, the range must not be 
+specified, as all tag values are returned.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+            'dataSourceRid': data_source_rid,
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/data-source/v1/data-sources/{dataSourceRid}/get-tags'
+        _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[api_TagName, List[api_TagValue]], self._return_none_for_unknown_union_types)
+
 
 scout_datasource_DataSourceService.__name__ = "DataSourceService"
 scout_datasource_DataSourceService.__qualname__ = "DataSourceService"
@@ -56989,7 +57088,7 @@ class scout_datasource_connection_api_Connection(ConjureBeanType):
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
             'connection_details': ConjureFieldDefinition('connectionDetails', scout_datasource_connection_api_ConnectionDetails),
             'required_tag_names': ConjureFieldDefinition('requiredTagNames', List[api_TagName]),
-            'available_tag_values': ConjureFieldDefinition('availableTagValues', Dict[api_TagName, List[api_TagValue]]),
+            'available_tag_values': ConjureFieldDefinition('availableTagValues', OptionalTypeWrapper[Dict[api_TagName, List[api_TagValue]]]),
             'metadata': ConjureFieldDefinition('metadata', Dict[str, str]),
             'scraping': ConjureFieldDefinition('scraping', OptionalTypeWrapper[scout_datasource_connection_api_ScrapingConfig]),
             'should_scrape': ConjureFieldDefinition('shouldScrape', bool),
@@ -57000,7 +57099,7 @@ class scout_datasource_connection_api_Connection(ConjureBeanType):
 
     __slots__: List[str] = ['_rid', '_display_name', '_description', '_connection_details', '_required_tag_names', '_available_tag_values', '_metadata', '_scraping', '_should_scrape', '_limits', '_connection_status', '_is_archived']
 
-    def __init__(self, available_tag_values: Dict[str, List[str]], connection_details: "scout_datasource_connection_api_ConnectionDetails", connection_status: "scout_datasource_connection_api_ConnectionStatus", display_name: str, is_archived: bool, metadata: Dict[str, str], required_tag_names: List[str], rid: 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, connection_details: "scout_datasource_connection_api_ConnectionDetails", connection_status: "scout_datasource_connection_api_ConnectionStatus", display_name: str, is_archived: bool, metadata: Dict[str, str], required_tag_names: List[str], rid: str, should_scrape: bool, available_tag_values: Optional[Dict[str, List[str]]] = None, description: Optional[str] = None, limits: Optional["scout_datasource_connection_api_LimitsConfig"] = None, scraping: Optional["scout_datasource_connection_api_ScrapingConfig"] = None) -> None:
         self._rid = rid
         self._display_name = display_name
         self._description = description
@@ -57042,7 +57141,10 @@ rather than strictly required.
         return self._required_tag_names
 
     @builtins.property
-    def available_tag_values(self) -> Dict[str, List[str]]:
+    def available_tag_values(self) -> Optional[Dict[str, List[str]]]:
+        """
+        Deprecated, use the getAvailableTagsForConnection endpoint instead
+        """
         return self._available_tag_values
 
     @builtins.property

{nominal_api-0.622.3 → nominal_api-0.624.0}/nominal_api/api/__init__.py

@@ -22,6 +22,7 @@ from .._impl import (
     api_Property as Property,
     api_PropertyName as PropertyName,
     api_PropertyValue as PropertyValue,
+    api_Range as Range,
     api_S3Path as S3Path,
     api_SerializableError as SerializableError,
     api_SeriesArchetypeRid as SeriesArchetypeRid,

{nominal_api-0.622.3 → nominal_api-0.624.0}/nominal_api/datasource_api/__init__.py

@@ -17,6 +17,7 @@ from .._impl import (
     datasource_api_GetAvailableTagsForChannelResponse as GetAvailableTagsForChannelResponse,
     datasource_api_GetDataScopeBoundsRequest as GetDataScopeBoundsRequest,
     datasource_api_GetDataScopeBoundsResponse as GetDataScopeBoundsResponse,
+    datasource_api_GetTagValuesForDataSourceRequest as GetTagValuesForDataSourceRequest,
     datasource_api_IndexChannelPrefixTreeRequest as IndexChannelPrefixTreeRequest,
     datasource_api_SearchChannelsRequest as SearchChannelsRequest,
     datasource_api_SearchChannelsResponse as SearchChannelsResponse,

{nominal_api-0.622.3 → nominal_api-0.624.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.622.3 → nominal_api-0.624.0}/setup.py

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