nominal-api 0.623.0__py3-none-any.whl → 0.624.0__py3-none-any.whl

nominal_api/__init__.py

@@ -76,5 +76,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.623.0"
+__version__ = "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/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/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.623.0.dist-info → nominal_api-0.624.0.dist-info}/METADATA

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

{nominal_api-0.623.0.dist-info → nominal_api-0.624.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-nominal_api/__init__.py,sha256=0G-zmhqQ_3xFeqfbtuSRQnzBTz8w4Z9k3tithBihh9M,1995
-nominal_api/_impl.py,sha256=4SPkC1z2YVLR5yVTKHgJrp6fCY-ij0n01_RUhH6yv-w,2992953
+nominal_api/__init__.py,sha256=z9TAYSaOADm5ISQy4xx5yD0VbDejQ8spOwhxfaYYrNo,1995
+nominal_api/_impl.py,sha256=hNLXhm7Of7lwzrCBGMMRCwSvSvN05AhbLK9NeTrtmKQ,2996592
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
-nominal_api/api/__init__.py,sha256=f6fvZACzXUPSIN-H855AjAYLwmisy_VrHy4Ie2HXiNE,1270
+nominal_api/api/__init__.py,sha256=1oJPOuAMfV2uClPUW8Ie1nj2Y6j81TDpedcc3yUFTe0,1294
 nominal_api/api_ids/__init__.py,sha256=CAtt44XgNZEEUDv-BbEbYtuxQ8y1wqSZU-STjBYdZv8,80
 nominal_api/api_rids/__init__.py,sha256=qerno2fgGWLfokoSdCarKSXg2jDjTJpz45Wv8PnqI6Q,500
 nominal_api/attachments_api/__init__.py,sha256=eQBE8xVTFDaTItCZv-WJSZqSStpgdai192n23pmVeeQ,634
@@ -10,7 +10,7 @@ nominal_api/authorization/__init__.py,sha256=F6JRzi_O0vr5jgwPbDlQMHLLKpCzyc9u5DY
 nominal_api/comments_api/__init__.py,sha256=bt24EdmTY513nKMrWMCsfYV0XmX7VKQgOFH4I4tKWy4,860
 nominal_api/connect_download/__init__.py,sha256=kYpjIjuFHA3uix70bJ5gV9-7BmDcJZAcm_e3MeMVSSQ,83
 nominal_api/datasource/__init__.py,sha256=C2lvxiWYnZRjaMKL2sY9_bfgZezBpK39A3VtgSASgRI,134
-nominal_api/datasource_api/__init__.py,sha256=5TddGrr5x6bZdVun00Zb_BwwcQtP35Yvn1DSxZ6QZmI,2074
+nominal_api/datasource_api/__init__.py,sha256=-0v4FGK22kyCALrJ-LRcwJ-QHDUnFCBqj_LkpEt_rgs,2163
 nominal_api/datasource_logset/__init__.py,sha256=H3fNxqyYC490MwvdWbt5BwhgWQUev7uieaLz5hUbZDc,94
 nominal_api/datasource_logset_api/__init__.py,sha256=JyjO1tQmG-HZ7kYMi8lSfeaaYddBZdCMIyqc0IUJfWo,1006
 nominal_api/datasource_pagination_api/__init__.py,sha256=3GO8TAUavOe6dUEitOhje74aSZHjTKVI5N1MNuct1lI,212
@@ -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.623.0.dist-info/METADATA,sha256=YBLiL8d0hhZd6AX8fcM0Qkt6uZiPEqOgvCV8Yx7mtAs,199
-nominal_api-0.623.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-nominal_api-0.623.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.623.0.dist-info/RECORD,,
+nominal_api-0.624.0.dist-info/METADATA,sha256=2YmbdPMkf1JoqFQQZn4F6YioJ0WUW17KIX2Rxfa18sA,199
+nominal_api-0.624.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+nominal_api-0.624.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.624.0.dist-info/RECORD,,