nominal-api 0.557.0__tar.gz → 0.558.0__tar.gz

{nominal_api-0.557.0 → nominal_api-0.558.0}/PKG-INFO

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

{nominal_api-0.557.0 → nominal_api-0.558.0}/nominal_api/__init__.py

@@ -36,6 +36,8 @@ __all__ = [
     'scout_datasource_connection',
     'scout_datasource_connection_api',
     'scout_datasource_connection_api_influx',
+    'scout_favorites',
+    'scout_favorites_api',
     'scout_integrations_api',
     'scout_internal_search_api',
     'scout_jobs_api',
@@ -67,5 +69,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.557.0"
+__version__ = "0.558.0"
 

{nominal_api-0.557.0 → nominal_api-0.558.0}/nominal_api/_impl.py

@@ -54092,6 +54092,348 @@ scout_datasource_connection_api_VisualCrossingType.__qualname__ = "VisualCrossin
 scout_datasource_connection_api_VisualCrossingType.__module__ = "nominal_api.scout_datasource_connection_api"
 
 
+class scout_favorites_FavoritesService(Service):
+    """
+    Creating favorites allows users to pin specific resources (i.e. assets, workbooks, etc.) as favorites for 
+quick access within search pages throughout the application for themselves.
+    """
+
+    def update_favorites(self, auth_header: str, request: "scout_favorites_api_UpdateFavoritesRequest") -> "scout_favorites_api_UpdateFavoritesResponse":
+        """
+        Update the user's favorited resources.
+        """
+
+        _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 = '/scout/v2/favorites'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'PUT',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), scout_favorites_api_UpdateFavoritesResponse, self._return_none_for_unknown_union_types)
+
+    def list_favorites(self, auth_header: str, request: "scout_favorites_api_ListFavoritesRequest") -> "scout_favorites_api_ListFavoritesResponse":
+        """
+        Retrieves all the user's favorites with filtering options on the resource types to include.
+        """
+
+        _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 = '/scout/v2/favorites/list'
+        _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_favorites_api_ListFavoritesResponse, self._return_none_for_unknown_union_types)
+
+
+scout_favorites_FavoritesService.__name__ = "FavoritesService"
+scout_favorites_FavoritesService.__qualname__ = "FavoritesService"
+scout_favorites_FavoritesService.__module__ = "nominal_api.scout_favorites"
+
+
+class scout_favorites_api_FavoriteResource(ConjureUnionType):
+    _asset: Optional[str] = None
+    _run: Optional[str] = None
+    _notebook: Optional[str] = None
+    _notebook_template: Optional[str] = None
+    _checklist: Optional[str] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'asset': ConjureFieldDefinition('asset', scout_rids_api_AssetRid),
+            'run': ConjureFieldDefinition('run', scout_run_api_RunRid),
+            'notebook': ConjureFieldDefinition('notebook', scout_rids_api_NotebookRid),
+            'notebook_template': ConjureFieldDefinition('notebookTemplate', scout_rids_api_TemplateRid),
+            'checklist': ConjureFieldDefinition('checklist', scout_rids_api_ChecklistRid)
+        }
+
+    def __init__(
+            self,
+            asset: Optional[str] = None,
+            run: Optional[str] = None,
+            notebook: Optional[str] = None,
+            notebook_template: Optional[str] = None,
+            checklist: Optional[str] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (asset is not None) + (run is not None) + (notebook is not None) + (notebook_template is not None) + (checklist is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if asset is not None:
+                self._asset = asset
+                self._type = 'asset'
+            if run is not None:
+                self._run = run
+                self._type = 'run'
+            if notebook is not None:
+                self._notebook = notebook
+                self._type = 'notebook'
+            if notebook_template is not None:
+                self._notebook_template = notebook_template
+                self._type = 'notebookTemplate'
+            if checklist is not None:
+                self._checklist = checklist
+                self._type = 'checklist'
+
+        elif type_of_union == 'asset':
+            if asset is None:
+                raise ValueError('a union value must not be None')
+            self._asset = asset
+            self._type = 'asset'
+        elif type_of_union == 'run':
+            if run is None:
+                raise ValueError('a union value must not be None')
+            self._run = run
+            self._type = 'run'
+        elif type_of_union == 'notebook':
+            if notebook is None:
+                raise ValueError('a union value must not be None')
+            self._notebook = notebook
+            self._type = 'notebook'
+        elif type_of_union == 'notebookTemplate':
+            if notebook_template is None:
+                raise ValueError('a union value must not be None')
+            self._notebook_template = notebook_template
+            self._type = 'notebookTemplate'
+        elif type_of_union == 'checklist':
+            if checklist is None:
+                raise ValueError('a union value must not be None')
+            self._checklist = checklist
+            self._type = 'checklist'
+
+    @builtins.property
+    def asset(self) -> Optional[str]:
+        return self._asset
+
+    @builtins.property
+    def run(self) -> Optional[str]:
+        return self._run
+
+    @builtins.property
+    def notebook(self) -> Optional[str]:
+        return self._notebook
+
+    @builtins.property
+    def notebook_template(self) -> Optional[str]:
+        return self._notebook_template
+
+    @builtins.property
+    def checklist(self) -> Optional[str]:
+        return self._checklist
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_favorites_api_FavoriteResourceVisitor):
+            raise ValueError('{} is not an instance of scout_favorites_api_FavoriteResourceVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'asset' and self.asset is not None:
+            return visitor._asset(self.asset)
+        if self._type == 'run' and self.run is not None:
+            return visitor._run(self.run)
+        if self._type == 'notebook' and self.notebook is not None:
+            return visitor._notebook(self.notebook)
+        if self._type == 'notebookTemplate' and self.notebook_template is not None:
+            return visitor._notebook_template(self.notebook_template)
+        if self._type == 'checklist' and self.checklist is not None:
+            return visitor._checklist(self.checklist)
+
+
+scout_favorites_api_FavoriteResource.__name__ = "FavoriteResource"
+scout_favorites_api_FavoriteResource.__qualname__ = "FavoriteResource"
+scout_favorites_api_FavoriteResource.__module__ = "nominal_api.scout_favorites_api"
+
+
+class scout_favorites_api_FavoriteResourceVisitor:
+
+    @abstractmethod
+    def _asset(self, asset: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _run(self, run: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _notebook(self, notebook: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _notebook_template(self, notebook_template: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _checklist(self, checklist: str) -> Any:
+        pass
+
+
+scout_favorites_api_FavoriteResourceVisitor.__name__ = "FavoriteResourceVisitor"
+scout_favorites_api_FavoriteResourceVisitor.__qualname__ = "FavoriteResourceVisitor"
+scout_favorites_api_FavoriteResourceVisitor.__module__ = "nominal_api.scout_favorites_api"
+
+
+class scout_favorites_api_ListFavoritesRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'resource_types': ConjureFieldDefinition('resourceTypes', OptionalTypeWrapper[List[scout_favorites_api_ResourceType]])
+        }
+
+    __slots__: List[str] = ['_resource_types']
+
+    def __init__(self, resource_types: Optional[List["scout_favorites_api_ResourceType"]] = None) -> None:
+        self._resource_types = resource_types
+
+    @builtins.property
+    def resource_types(self) -> Optional[List["scout_favorites_api_ResourceType"]]:
+        return self._resource_types
+
+
+scout_favorites_api_ListFavoritesRequest.__name__ = "ListFavoritesRequest"
+scout_favorites_api_ListFavoritesRequest.__qualname__ = "ListFavoritesRequest"
+scout_favorites_api_ListFavoritesRequest.__module__ = "nominal_api.scout_favorites_api"
+
+
+class scout_favorites_api_ListFavoritesResponse(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'favorites': ConjureFieldDefinition('favorites', List[scout_favorites_api_FavoriteResource])
+        }
+
+    __slots__: List[str] = ['_favorites']
+
+    def __init__(self, favorites: List["scout_favorites_api_FavoriteResource"]) -> None:
+        self._favorites = favorites
+
+    @builtins.property
+    def favorites(self) -> List["scout_favorites_api_FavoriteResource"]:
+        """
+        The user's favorite resources. Ordered the same as the resources provided when updating favorites.
+        """
+        return self._favorites
+
+
+scout_favorites_api_ListFavoritesResponse.__name__ = "ListFavoritesResponse"
+scout_favorites_api_ListFavoritesResponse.__qualname__ = "ListFavoritesResponse"
+scout_favorites_api_ListFavoritesResponse.__module__ = "nominal_api.scout_favorites_api"
+
+
+class scout_favorites_api_ResourceType(ConjureEnumType):
+
+    ASSET = 'ASSET'
+    '''ASSET'''
+    RUN = 'RUN'
+    '''RUN'''
+    NOTEBOOK = 'NOTEBOOK'
+    '''NOTEBOOK'''
+    NOTEBOOK_TEMPLATE = 'NOTEBOOK_TEMPLATE'
+    '''NOTEBOOK_TEMPLATE'''
+    CHECKLIST = 'CHECKLIST'
+    '''CHECKLIST'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_favorites_api_ResourceType.__name__ = "ResourceType"
+scout_favorites_api_ResourceType.__qualname__ = "ResourceType"
+scout_favorites_api_ResourceType.__module__ = "nominal_api.scout_favorites_api"
+
+
+class scout_favorites_api_UpdateFavoritesRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'resources': ConjureFieldDefinition('resources', List[scout_favorites_api_FavoriteResource])
+        }
+
+    __slots__: List[str] = ['_resources']
+
+    def __init__(self, resources: List["scout_favorites_api_FavoriteResource"]) -> None:
+        self._resources = resources
+
+    @builtins.property
+    def resources(self) -> List["scout_favorites_api_FavoriteResource"]:
+        """
+        The resources to set as the user's favorites. Note that the provided list will overwrite 
+all the user's previous favorites.
+        """
+        return self._resources
+
+
+scout_favorites_api_UpdateFavoritesRequest.__name__ = "UpdateFavoritesRequest"
+scout_favorites_api_UpdateFavoritesRequest.__qualname__ = "UpdateFavoritesRequest"
+scout_favorites_api_UpdateFavoritesRequest.__module__ = "nominal_api.scout_favorites_api"
+
+
+class scout_favorites_api_UpdateFavoritesResponse(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'favorites': ConjureFieldDefinition('favorites', List[scout_favorites_api_FavoriteResource])
+        }
+
+    __slots__: List[str] = ['_favorites']
+
+    def __init__(self, favorites: List["scout_favorites_api_FavoriteResource"]) -> None:
+        self._favorites = favorites
+
+    @builtins.property
+    def favorites(self) -> List["scout_favorites_api_FavoriteResource"]:
+        """
+        The user's updated favorite resources. Maintains the same ordering as the resources in the request.
+        """
+        return self._favorites
+
+
+scout_favorites_api_UpdateFavoritesResponse.__name__ = "UpdateFavoritesResponse"
+scout_favorites_api_UpdateFavoritesResponse.__qualname__ = "UpdateFavoritesResponse"
+scout_favorites_api_UpdateFavoritesResponse.__module__ = "nominal_api.scout_favorites_api"
+
+
 class scout_integrations_api_CreateIntegrationDetails(ConjureUnionType):
     _create_simple_webhook_details: Optional["scout_integrations_api_CreateSimpleWebhookDetails"] = None
     _create_opsgenie_integration_details: Optional["scout_integrations_api_CreateOpsgenieIntegrationDetails"] = None

nominal_api-0.558.0/nominal_api/scout_favorites/__init__.py

@@ -0,0 +1,5 @@
+# coding=utf-8
+from .._impl import (
+    scout_favorites_FavoritesService as FavoritesService,
+)
+

nominal_api-0.558.0/nominal_api/scout_favorites_api/__init__.py

@@ -0,0 +1,11 @@
+# coding=utf-8
+from .._impl import (
+    scout_favorites_api_FavoriteResource as FavoriteResource,
+    scout_favorites_api_FavoriteResourceVisitor as FavoriteResourceVisitor,
+    scout_favorites_api_ListFavoritesRequest as ListFavoritesRequest,
+    scout_favorites_api_ListFavoritesResponse as ListFavoritesResponse,
+    scout_favorites_api_ResourceType as ResourceType,
+    scout_favorites_api_UpdateFavoritesRequest as UpdateFavoritesRequest,
+    scout_favorites_api_UpdateFavoritesResponse as UpdateFavoritesResponse,
+)
+

{nominal_api-0.557.0 → nominal_api-0.558.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.557.0 → nominal_api-0.558.0}/nominal_api.egg-info/SOURCES.txt

@@ -43,6 +43,8 @@ nominal_api/scout_datasource/__init__.py
 nominal_api/scout_datasource_connection/__init__.py
 nominal_api/scout_datasource_connection_api/__init__.py
 nominal_api/scout_datasource_connection_api_influx/__init__.py
+nominal_api/scout_favorites/__init__.py
+nominal_api/scout_favorites_api/__init__.py
 nominal_api/scout_integrations_api/__init__.py
 nominal_api/scout_internal_search_api/__init__.py
 nominal_api/scout_jobs_api/__init__.py

{nominal_api-0.557.0 → nominal_api-0.558.0}/setup.py

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