xautomata-hive 3.20.1__py3-none-any.whl → 3.21.0__py3-none-any.whl

hive/api.py

@@ -52,6 +52,7 @@ class ApiManager:
     _timeout_sleep_time = 120  # tempo di attesa tra un retry e quello successivo in caso di timeout
     _silence_warning = False  # da implementare
     num_items = None  # serve per quando si mette la count a True, di default vale 0
+    response = []  # variabile in cui mettere la risposta degli endpoing per poter accedere alla versione originale
 
     def __init__(self, root, user, password, ssl_verify: bool = True):
 
@@ -155,6 +156,8 @@ class ApiManager:
 
         url = f'{self.root}{path}'
 
+        self.response = []  # reset dell'attributo responce, cosi da non accodare risposte proveninenti da richieste diverse
+
         @warmstart(active=warm_start, args_ex=[2], verbose=False)
         @paginate(single_page=single_page, page_size=page_size, skip=_params_['skip'], limit=_params_['limit'], bulk=bulk)
         @timeout_retry(max_tries=self._timeout_retry, sleep_time=self._timeout_sleep_time)
@@ -166,7 +169,8 @@ class ApiManager:
             logger.debug(f'request params (skip and limit may differ from your setting due pagination): {_params}')
             logger.debug(f'request payload: {_payload}')
 
-            response = get_session(self._timeout, self._timeout_get_session_retry, self._timeout_get_session_backoff_factor).request(_mode, url=_url, json=_payload, params=_params, headers=_headers, verify=self._SSL_verify, **_kwargs)
+            response = get_session(self._timeout, self._timeout_get_session_retry, self._timeout_get_session_backoff_factor).request(_mode, url=_url, json=_payload, params=_params,
+                                                                                                                                     headers=_headers, verify=self._SSL_verify, **_kwargs)
             if response.status_code == 401: raise UnauthorizedException
             if response.status_code != 200 and response.status_code != 504:  # 504 non e' gestito dalle API per cui la responce non sarebbe json serializable
                 logger.error(response.json())
@@ -178,6 +182,8 @@ class ApiManager:
             logger.debug(f'responce: {response.json()}')
             logger.debug(f'header: {response.headers}')
 
+            self.response.append(response)  # sotto forma di lista perche se la risposta viene paginata questa viene spezzata su piu risposte
+
             return response.json()
 
         return run_request(mode, url, _headers_, _payload_, _params_, **kwargs)
@@ -516,6 +522,7 @@ from hive.cookbook.schedules import Schedules
 from hive.cookbook.services import Services
 from hive.cookbook.sites import Sites
 from hive.cookbook.last_status import LastStatus
+from hive.cookbook.last_object_status import LastObjectStatus
 from hive.cookbook.last_status_v2 import LastStatusV2
 from hive.cookbook.terms_and_conditions import TermsAndConditions
 from hive.cookbook.tree_hierarchy import TreeHierarchy
@@ -538,7 +545,7 @@ from hive.cookbook.widget_groups import WidgetGroups
 # hive imports stop
 
 
-class XautomataApi(AclDocs, AclOverrides, Analytics, Anomalies, Calendars, CostTagging, CostTags, CostViews, CostTreeNodes, CostTreeResources, Contacts, Customers, Dashboards, Dispatchers, Downtimes, ExternalTickets, Features, Files, FirmwareUpdates, Groups, AutomataIngest, MetricIngest, Microsoft, Google, Login, Jobs, Messages, Metrics, ProbesLogIngest, MetricTypes, NotificationProviders, NotificationProviderTypes, Objects, OpeningReasons, Probes, ProbeTypes, ProfileTopics, Questions, ReasonForClosure, RetentionRules, Schedules, Services, Sites, LastStatus, LastStatusV2, TermsAndConditions, TreeHierarchy, TreeHierarchyV2, TsAutomataState, TsCostAzureRaw, TsCostManagement, TsCostManagementV2, TsMetricStatus, TsMetricValue, TsNtopFlows, TsServiceStatus, TsServiceValue, Users, UsersNotifications, VirtualDomains, Widgets, Webhooks, WidgetGroups):
+class XautomataApi(AclDocs, AclOverrides, Analytics, Anomalies, Calendars, CostTagging, CostTags, CostViews, CostTreeNodes, CostTreeResources, Contacts, Customers, Dashboards, Dispatchers, Downtimes, ExternalTickets, Features, Files, FirmwareUpdates, Groups, AutomataIngest, MetricIngest, Microsoft, Google, Login, Jobs, Messages, Metrics, ProbesLogIngest, MetricTypes, NotificationProviders, NotificationProviderTypes, Objects, OpeningReasons, Probes, ProbeTypes, ProfileTopics, Questions, ReasonForClosure, RetentionRules, Schedules, Services, Sites, LastStatus, LastObjectStatus, LastStatusV2, TermsAndConditions, TreeHierarchy, TreeHierarchyV2, TsAutomataState, TsCostAzureRaw, TsCostManagement, TsCostManagementV2, TsMetricStatus, TsMetricValue, TsNtopFlows, TsServiceStatus, TsServiceValue, Users, UsersNotifications, VirtualDomains, Widgets, Webhooks, WidgetGroups):
     """
     Class with each specific API, based on the ApiManager Class created for a more general interaction with Xautomata API
     """

hive/cookbook/cost_tree_nodes.py

@@ -197,6 +197,39 @@ class CostTreeNodes(ApiManager):
             params=params, **kwargs)
         return response
 
+    def cost_tree_nodes_navigate_tree_v2(self, uuid: str,
+        warm_start: bool = False, kwargs: dict = None, **params) -> list:
+        """Get Tree From Node V2
+
+        Args:
+            uuid (str, required): uuid
+            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            date_start (string required): additional filter - parameter
+            date_end (string required): additional filter - parameter
+            resource_id (string optional): additional filter - parameter
+            previous_period (boolean optional): additional filter - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
+            =params)
+        official_params_list = ['date_start', 'date_end', 'resource_id',
+            'previous_period']
+        params.get('date_start'), params.get('date_end'), params.get(
+            'resource_id'), params.get('previous_period')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.cost_tree_nodes_navigate_tree_v2.
+                __name__, params, official_params_list)
+        response = self.execute('GET', path=
+            f'/cost_tree_nodes/navigate_tree/{uuid}/v2', warm_start=
+            warm_start, params=params, **kwargs)
+        return response
+
     def cost_tree_nodes_get_node_resources(self, uuid: str,
         warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:

hive/cookbook/cost_tree_resources.py

@@ -119,6 +119,48 @@ class CostTreeResources(ApiManager):
             =params, **kwargs)
         return response
 
+    def cost_tree_resources_all_resource_ids_v2(self,
+        warm_start: bool = False, single_page: bool = False,
+        page_size: int = 5000, kwargs: dict = None, **params) -> list:
+        """Get Resource Ids V2
+
+        Args:
+            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
+            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
+            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            date_start (string required): additional filter - parameter
+            date_end (string required): additional filter - parameter
+            uuid_customer (string optional): additional filter - parameter
+            uuid_view (string optional): additional filter - parameter
+            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
+            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
+            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
+            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
+            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_params_list = ['date_start', 'date_end', 'uuid_customer',
+            'uuid_view', 'skip', 'limit', 'like', 'join', 'count']
+        params.get('date_start'), params.get('date_end'), params.get(
+            'uuid_customer'), params.get('uuid_view'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.
+                cost_tree_resources_all_resource_ids_v2.__name__, params,
+                official_params_list)
+        response = self.execute('GET', path=
+            f'/cost_tree_resources/all_resource_ids/v2', single_page=
+            single_page, page_size=page_size, warm_start=warm_start, params
+            =params, **kwargs)
+        return response
+
     def cost_tree_resources_unfully_assigned_resource_ids(self,
         uuid_view: str, warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:
@@ -155,6 +197,42 @@ class CostTreeResources(ApiManager):
             warm_start, params=params, **kwargs)
         return response
 
+    def cost_tree_resources_unfully_assigned_resource_ids_v2(self,
+        uuid_view: str, warm_start: bool = False, single_page: bool = False,
+        page_size: int = 5000, kwargs: dict = None, **params) -> list:
+        """Get Unfully Assigned Resource Ids V2
+
+        Args:
+            uuid_view (str, required): uuid_view
+            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
+            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
+            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
+            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
+            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
+            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
+            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_params_list = ['skip', 'limit', 'like', 'join', 'count']
+        params.get('skip'), params.get('limit'), params.get('like'
+            ), params.get('join'), params.get('count')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.
+                cost_tree_resources_unfully_assigned_resource_ids_v2.
+                __name__, params, official_params_list)
+        response = self.execute('GET', path=
+            f'/cost_tree_resources/{uuid_view}/unfully_assigned_resource_ids/v2'
+            , single_page=single_page, page_size=page_size, warm_start=
+            warm_start, params=params, **kwargs)
+        return response
+
     def cost_tree_resources_unfully_assigned_resources(self, uuid_view: str,
         warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:

hive/cookbook/last_object_status.py

@@ -0,0 +1,213 @@
+from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
+
+
+class LastObjectStatus(ApiManager):
+    """Class that handles all the XAutomata last_object_status APIs"""
+
+    def last_object_status(self, warm_start: bool = False,
+        single_page: bool = False, page_size: int = 5000,
+        kwargs: dict = None, **params) -> list:
+        """Read Last Object Status
+
+        Args:
+            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
+            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
+            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            extract_valueless_metrics (boolean optional): additional filter - parameter
+            extract_automata_domain (None optional): additional filter - parameter
+            sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
+            null_fields (string optional): additional filter - parameter
+            uuid_customer (string optional): additional filter - parameter
+            customer_code (string optional): additional filter - parameter
+            customer_status (string optional): additional filter - parameter
+            uuid_site (string optional): additional filter - parameter
+            site_code (string optional): additional filter - parameter
+            site_description (string optional): additional filter - parameter
+            site_address (string optional): additional filter - parameter
+            site_zip_code (string optional): additional filter - parameter
+            site_city (string optional): additional filter - parameter
+            site_country (string optional): additional filter - parameter
+            site_state_province (string optional): additional filter - parameter
+            site_status (string optional): additional filter - parameter
+            uuid_group (string optional): additional filter - parameter
+            group_name (string optional): additional filter - parameter
+            group_status (string optional): additional filter - parameter
+            group_type (string optional): additional filter - parameter
+            uuid_object (string optional): additional filter - parameter
+            object_name (string optional): additional filter - parameter
+            object_status (string optional): additional filter - parameter
+            object_profile (string optional): additional filter - parameter
+            uuid_metric_type (string optional): additional filter - parameter
+            metric_type_name (string optional): additional filter - parameter
+            metric_type_status (string optional): additional filter - parameter
+            uuid_metric (string optional): additional filter - parameter
+            metric_name (string optional): additional filter - parameter
+            metric_status (string optional): additional filter - parameter
+            metric_profile (string optional): additional filter - parameter
+            topic (string optional): additional filter - parameter
+            last_value_uuid_probe (string optional): additional filter - parameter
+            last_value_timestamp_start (string optional): additional filter - parameter
+            last_value_timestamp_end (string optional): additional filter - parameter
+            last_value_object_type (string optional): additional filter - parameter
+            last_value_name (string optional): additional filter - parameter
+            last_value_value (string optional): additional filter - parameter
+            last_value_unit (string optional): additional filter - parameter
+            last_value_description (string optional): additional filter - parameter
+            last_value_status (None optional): additional filter - parameter
+            last_value_ranking (integer optional): additional filter - parameter
+            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
+            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
+            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
+            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
+            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_params_list = ['extract_valueless_metrics',
+            'extract_automata_domain', 'sort_by', 'null_fields',
+            'uuid_customer', 'customer_code', 'customer_status',
+            'uuid_site', 'site_code', 'site_description', 'site_address',
+            'site_zip_code', 'site_city', 'site_country',
+            'site_state_province', 'site_status', 'uuid_group',
+            'group_name', 'group_status', 'group_type', 'uuid_object',
+            'object_name', 'object_status', 'object_profile',
+            'uuid_metric_type', 'metric_type_name', 'metric_type_status',
+            'uuid_metric', 'metric_name', 'metric_status', 'metric_profile',
+            'topic', 'last_value_uuid_probe', 'last_value_timestamp_start',
+            'last_value_timestamp_end', 'last_value_object_type',
+            'last_value_name', 'last_value_value', 'last_value_unit',
+            'last_value_description', 'last_value_status',
+            'last_value_ranking', 'skip', 'limit', 'like', 'join', 'count']
+        params.get('extract_valueless_metrics'), params.get(
+            'extract_automata_domain'), params.get('sort_by'), params.get(
+            'null_fields'), params.get('uuid_customer'), params.get(
+            'customer_code'), params.get('customer_status'), params.get(
+            'uuid_site'), params.get('site_code'), params.get(
+            'site_description'), params.get('site_address'), params.get(
+            'site_zip_code'), params.get('site_city'), params.get(
+            'site_country'), params.get('site_state_province'), params.get(
+            'site_status'), params.get('uuid_group'), params.get('group_name'
+            ), params.get('group_status'), params.get('group_type'
+            ), params.get('uuid_object'), params.get('object_name'
+            ), params.get('object_status'), params.get('object_profile'
+            ), params.get('uuid_metric_type'), params.get('metric_type_name'
+            ), params.get('metric_type_status'), params.get('uuid_metric'
+            ), params.get('metric_name'), params.get('metric_status'
+            ), params.get('metric_profile'), params.get('topic'), params.get(
+            'last_value_uuid_probe'), params.get('last_value_timestamp_start'
+            ), params.get('last_value_timestamp_end'), params.get(
+            'last_value_object_type'), params.get('last_value_name'
+            ), params.get('last_value_value'), params.get('last_value_unit'
+            ), params.get('last_value_description'), params.get(
+            'last_value_status'), params.get('last_value_ranking'), params.get(
+            'skip'), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.last_object_status.__name__,
+                params, official_params_list)
+        response = self.execute('GET', path=f'/last_object_status/',
+            single_page=single_page, page_size=page_size, warm_start=
+            warm_start, params=params, **kwargs)
+        return response
+
+    def last_object_status_create(self, params: dict = False,
+        kwargs: dict = None, **payload) -> list:
+        """Read Last Object Status Lists
+
+        Args:
+            params (dict, optional): additional parameters for the API.
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **payload: additional parameters for the API.
+
+        Keyword Args:
+            sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
+            null_fields (string optional): additional filter - parameter
+            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
+            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
+            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
+            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
+            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
+            uuid_customer (array optional): additional filter - payload
+            customer_code (array optional): additional filter - payload
+            customer_status (array optional): additional filter - payload
+            uuid_site (array optional): additional filter - payload
+            site_code (array optional): additional filter - payload
+            site_description (array optional): additional filter - payload
+            site_address (array optional): additional filter - payload
+            site_zip_code (array optional): additional filter - payload
+            site_city (array optional): additional filter - payload
+            site_country (array optional): additional filter - payload
+            site_state_province (array optional): additional filter - payload
+            site_status (array optional): additional filter - payload
+            uuid_group (array optional): additional filter - payload
+            group_name (array optional): additional filter - payload
+            group_status (array optional): additional filter - payload
+            group_type (array optional): additional filter - payload
+            uuid_object (array optional): additional filter - payload
+            object_name (array optional): additional filter - payload
+            object_status (array optional): additional filter - payload
+            object_profile (array optional): additional filter - payload
+            uuid_metric_type (array optional): additional filter - payload
+            metric_type_name (array optional): additional filter - payload
+            metric_type_status (array optional): additional filter - payload
+            uuid_metric (array optional): additional filter - payload
+            metric_name (array optional): additional filter - payload
+            metric_status (array optional): additional filter - payload
+            metric_profile (array optional): additional filter - payload
+            topic (array optional): additional filter - payload
+            last_value_uuid_probe (array optional): additional filter - payload
+            last_value_timestamp (array optional): additional filter - payload
+            last_value_object_type (array optional): additional filter - payload
+            last_value_name (array optional): additional filter - payload
+            last_value_value (array optional): additional filter - payload
+            last_value_unit (array optional): additional filter - payload
+            last_value_description (array optional): additional filter - payload
+            last_value_status (array optional): additional filter - payload
+            last_value_ranking (array optional): additional filter - payload
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_payload_list = ['uuid_customer', 'customer_code',
+            'customer_status', 'uuid_site', 'site_code', 'site_description',
+            'site_address', 'site_zip_code', 'site_city', 'site_country',
+            'site_state_province', 'site_status', 'uuid_group',
+            'group_name', 'group_status', 'group_type', 'uuid_object',
+            'object_name', 'object_status', 'object_profile',
+            'uuid_metric_type', 'metric_type_name', 'metric_type_status',
+            'uuid_metric', 'metric_name', 'metric_status', 'metric_profile',
+            'topic', 'last_value_uuid_probe', 'last_value_timestamp',
+            'last_value_object_type', 'last_value_name', 'last_value_value',
+            'last_value_unit', 'last_value_description',
+            'last_value_status', 'last_value_ranking']
+        payload.get('uuid_customer'), payload.get('customer_code'
+            ), payload.get('customer_status'), payload.get('uuid_site'
+            ), payload.get('site_code'), payload.get('site_description'
+            ), payload.get('site_address'), payload.get('site_zip_code'
+            ), payload.get('site_city'), payload.get('site_country'
+            ), payload.get('site_state_province'), payload.get('site_status'
+            ), payload.get('uuid_group'), payload.get('group_name'
+            ), payload.get('group_status'), payload.get('group_type'
+            ), payload.get('uuid_object'), payload.get('object_name'
+            ), payload.get('object_status'), payload.get('object_profile'
+            ), payload.get('uuid_metric_type'), payload.get('metric_type_name'
+            ), payload.get('metric_type_status'), payload.get('uuid_metric'
+            ), payload.get('metric_name'), payload.get('metric_status'
+            ), payload.get('metric_profile'), payload.get('topic'
+            ), payload.get('last_value_uuid_probe'), payload.get(
+            'last_value_timestamp'), payload.get('last_value_object_type'
+            ), payload.get('last_value_name'), payload.get('last_value_value'
+            ), payload.get('last_value_unit'), payload.get(
+            'last_value_description'), payload.get('last_value_status'
+            ), payload.get('last_value_ranking')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.last_object_status_create.
+                __name__, payload, official_payload_list)
+        response = self.execute('POST', path=f'/last_object_status/',
+            params=params, payload=payload, **kwargs)
+        return response

hive/cookbook/questions.py

@@ -110,6 +110,33 @@ class Questions(ApiManager):
             payload, **kwargs)
         return response
 
+    def questions_by_token(self, uuid: str, warm_start: bool = False,
+        kwargs: dict = None, **params) -> list:
+        """Read Tracking Question By Token
+
+        Args:
+            uuid (str, required): uuid
+            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            q-token (string required): additional filter - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
+            =params)
+        official_params_list = ['q-token']
+        params.get('q-token')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.questions_by_token.__name__,
+                params, official_params_list)
+        response = self.execute('GET', path=f'/questions/{uuid}/by_token',
+            warm_start=warm_start, params=params, **kwargs)
+        return response
+
     def questions_reset_put(self, uuid: str, kwargs: dict = None, **payload
         ) -> list:
         """Reset Tracking Question

hive/cookbook/ts_cost_azure_raw.py

@@ -592,3 +592,57 @@ class TsCostAzureRaw(ApiManager):
             f'/ts_cost_azure_raw/compute/tenant/{uuid_tenant}/', params=
             params, **kwargs)
         return response
+
+    def ts_cost_azure_raw_compute_import_tags_tenant_create(self,
+        uuid_tenant: str, kwargs: dict = None, **params) -> list:
+        """Bulk Import Tags Tenant
+
+        Args:
+            uuid_tenant (str, required): uuid_tenant
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            date_start (string required): additional filter - parameter
+            date_end (string required): additional filter - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_params_list = ['date_start', 'date_end']
+        params.get('date_start'), params.get('date_end')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.
+                ts_cost_azure_raw_compute_import_tags_tenant_create.
+                __name__, params, official_params_list)
+        response = self.execute('POST', path=
+            f'/ts_cost_azure_raw/compute/import_tags/tenant/{uuid_tenant}',
+            params=params, **kwargs)
+        return response
+
+    def ts_cost_azure_raw_compute_import_tags_customer_create(self,
+        uuid_customer: str, kwargs: dict = None, **params) -> list:
+        """Bulk Import Tags Customer
+
+        Args:
+            uuid_customer (str, required): uuid_customer
+            kwargs (dict, optional): additional parameters for execute. Default to None.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            date_start (string required): additional filter - parameter
+            date_end (string required): additional filter - parameter
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_params_list = ['date_start', 'date_end']
+        params.get('date_start'), params.get('date_end')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.
+                ts_cost_azure_raw_compute_import_tags_customer_create.
+                __name__, params, official_params_list)
+        response = self.execute('POST', path=
+            f'/ts_cost_azure_raw/compute/import_tags/customer/{uuid_customer}',
+            params=params, **kwargs)
+        return response

hive/cookbook/users.py

@@ -1052,6 +1052,7 @@ class Users(ApiManager):
         Keyword Args:
             subject (string required): additional filter - payload
             recipients (array required): additional filter - payload
+            ccn_recipients (array optional): additional filter - payload
             attachments (array optional): additional filter - payload
             template_parameters (object optional): additional filter - payload
             domain (string required): additional filter - payload
@@ -1059,11 +1060,11 @@ class Users(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
-        official_payload_list = ['subject', 'recipients', 'attachments',
-            'template_parameters', 'domain']
+        official_payload_list = ['subject', 'recipients', 'ccn_recipients',
+            'attachments', 'template_parameters', 'domain']
         payload.get('subject'), payload.get('recipients'), payload.get(
-            'attachments'), payload.get('template_parameters'), payload.get(
-            'domain')
+            'ccn_recipients'), payload.get('attachments'), payload.get(
+            'template_parameters'), payload.get('domain')
         if not self._silence_warning:
             warning_wrong_parameters(self.users_send_email_template_create.
                 __name__, payload, official_payload_list)

hive/cookbook/webhooks.py

@@ -115,16 +115,19 @@ class Webhooks(ApiManager):
         return response
 
     def webhooks_create_webhook_type(self, webhook_type: str,
-        kwargs: dict = None) -> list:
+        single_page: bool = False, page_size: int = 50, kwargs: dict = None
+        ) -> list:
         """Post Webhook
 
         Args:
             webhook_type (str, required): webhook_type
+            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
+            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
             kwargs (dict, optional): additional parameters for execute. Default to None.
 
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
         response = self.execute('POST', path=f'/webhooks/{webhook_type}',
-            **kwargs)
+            single_page=single_page, page_size=page_size, **kwargs)
         return response

hive/decorators.py

@@ -131,29 +131,55 @@ def timeout_retry(func=None, max_tries: int = 2, sleep_time: int = 60):
 
 
 def paginate(single_page: bool, page_size: int, skip: int, limit: int, bulk: bool):
+    """Questa funzione è un decorator che abilita la paginazione per una funzione.
+
+    Args:
+        single_page: se True, restituisce solo una singola "pagina" di risultati.
+        page_size: dimensione della pagina (numero massimo di elementi per chiamata).
+        skip: numero di elementi da saltare all'inizio.
+        limit: numero massimo di elementi da restituire.
+        bulk: se True, gestisce il payload in modalità "bulk", suddividendolo in chunk.
+    """
     def attributes(func):
+        # Questo è il decorator interno che avvolge la funzione passata (`func`).
         @functools.wraps(func)
         def behaviour(mode, url, headers, payload, params, **kwargs) -> list:
-            result = []
+            # `behaviour` è la funzione wrapper che implementa la logica di paginazione.
+            # Accetta i parametri della funzione originale (`func`) e aggiunge il supporto alla paginazione.
+            result = []  # Lista che conterrà i risultati aggregati.
 
             # se la chiamata è bulk, il payload deve essere un lista e qui viene divisa in chunk e viene chiamata un
             # chunk per volta, ogni chunk ha la dimensione del page_size
             if bulk and not single_page:  # se la bulk viene richiesta in single_page, ricade nell'uso normale
+                # Divide il payload in chunk della dimensione specificata da `page_size`.
                 c_payload = chunks(payload, page_size)
+                # Per ogni chunk:
                 for c in c_payload:
+                    # Chiama la funzione originale (`func`) con il chunk corrente.
                     result_partial = func(mode, url, headers, c, params, **kwargs)
+                    # Se il risultato non è una lista, lo converte in una lista.
                     if not isinstance(result_partial, list): result_partial = [result_partial]
+                    # Aggiunge i risultati parziali alla lista complessiva `result`.
                     result += result_partial
 
-            else:
-                size = page_size if not single_page else limit
-                params['skip'] = skip
-                params['limit'] = min(size, limit)
-                while True:
+            else:  # Se non è in modalità bulk o se è richiesto single_page:
+                size = page_size if not single_page else limit  # Determina la dimensione della pagina.
+                params['skip'] = skip  # Imposta il valore iniziale di `skip` nei parametri.
+                params['limit'] = min(size, limit)  # Imposta il limite massimo per la pagina corrente.
+                while True:  # Ciclo per iterare attraverso le pagine.
+                    # Chiama la funzione originale (`func`) con i parametri della pagina corrente.
                     result_partial = func(mode, url, headers, payload, params, **kwargs)
+                    # Se il risultato non è una lista, lo converte in una lista.
                     if not isinstance(result_partial, list): result_partial = [result_partial]
+                    # Aggiunge i risultati parziali alla lista complessiva `result`.
                     result += result_partial
+                    # Aggiorna il valore di `skip` per passare alla pagina successiva.
                     params['skip'] = params['skip'] + size
+                    # Interrompe il ciclo se:
+                    # - Non ci sono più risultati (`result_partial` è vuoto).
+                    # - Il numero di risultati è inferiore alla dimensione della pagina.
+                    # - Il numero totale di risultati supera il limite specificato.
+                    # - È richiesto il single_page.
                     if not result_partial or len(result_partial) < size or len(result) > limit or single_page: break
 
             # se count è True il result è una lista con dentro una tupla, in questa maniera viene trasmessa solo la tupla

hive/version.py

@@ -1 +1 @@
-version = '3.20.1'
+version = '3.21.0'

{xautomata_hive-3.20.1.dist-info → xautomata_hive-3.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xautomata-hive
-Version: 3.20.1
+Version: 3.21.0
 Home-page: https://github.com/sherlogic/xautomata-hive.git
 Author: Enrico Ferro - Andrea Jacassi
 Author-email: 
@@ -8,9 +8,9 @@ License: MIT
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: urllib3==2.0.4
 Requires-Dist: requests==2.31.0
 Requires-Dist: tqdm==4.64.1
-Requires-Dist: urllib3==2.0.4
 
 # Xautomata API
 Pacchetto che fornisca una interfaccia semplice per usare le API di Xautomata in python

{xautomata_hive-3.20.1.dist-info → xautomata_hive-3.21.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 hive/__init__.py,sha256=UjH5QfSfRGu2FR5_StfVbEtL_fuGS2Z_iZXmf1nx4AE,68
-hive/api.py,sha256=ioduCBzWxsoX5GWksArlPy5Ex5mg0_pJ5TY9JVa-n-I,41553
-hive/decorators.py,sha256=Lb2mYj7UpFaCzJXGKyLj3SmTK74zKMZgnC7Ys2j1D7g,9975
+hive/api.py,sha256=tXYFzcAEyWGmdQ3PWLD8u1m_4tCe4IL-YVAn6SUbahc,42151
+hive/decorators.py,sha256=qvXBMfkzmJ3nHzpnX96thrTdZjWuw4WAqYaxsJCfRug,12110
 hive/exceptions.py,sha256=kTJSPMViU2ZhF_ENbL_i-skU3YEv_ViJH2PpUQ6ums8,136
 hive/infrastrucure_keys.py,sha256=UzgXex6tQsglowhKeb45e7vw4u7kh2wM0YscQPorodU,4095
 hive/tools.py,sha256=Oi_d6wphtAS4f1wOhFzdXZj8Au1nwZ-UrRvIJDBQLMo,1371
-hive/version.py,sha256=XDQ-i6B48lB46NAx0EwQJ9cXIsrcU4NzOxRdRB3ftMs,18
+hive/version.py,sha256=CzEEPnYnPo514ZDmU-I_H_Uu3B3rOyK4rzwGXkNMQy0,18
 hive/cookbook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hive/cookbook/acl_docs.py,sha256=0xr7Vb9121vhsiZjQaKvuAt4gKlXOO4aUJM472HeARw,786
 hive/cookbook/acl_overrides.py,sha256=l3xyJmGeQysP1M2Sa6kVhDn8n6ttCKUzJ0jTcPjyo78,9690
@@ -15,8 +15,8 @@ hive/cookbook/calendars.py,sha256=1D1KpAACZbb96vaGqmC5MvvB7Juh908DI-_7BKE7Gkk,23
 hive/cookbook/contacts.py,sha256=vhkBjaxFoQA5P-GSGLsgtcvo3rbAPfHOCiB87tXtQsM,39183
 hive/cookbook/cost_tagging.py,sha256=wwLgo3YaDI4Xm7QcQVlf4kXxz8kPP7J7Qh4ddzuaDro,7779
 hive/cookbook/cost_tags.py,sha256=Dyf9HNXQstzSGbb7AWC1_D5i4hmFhM7jGQvrYSHZkVo,10038
-hive/cookbook/cost_tree_nodes.py,sha256=arceihdv8WqxgSv-Hdl_6GnzxlNqV7YSSvdM1P7GiQU,14253
-hive/cookbook/cost_tree_resources.py,sha256=dBlSCrzwAOdcGnt3lJZpAsqt4uv9Jnj0kQeYiRldPaE,14201
+hive/cookbook/cost_tree_nodes.py,sha256=lYpBXMl3IgjE__G7tSOzLvAIfytIB23kanmQkWW8Rak,15891
+hive/cookbook/cost_tree_resources.py,sha256=jB14aJlUrppkkFo6L7nWQI6dKwpGgjV3uLNwZGVu3f8,19677
 hive/cookbook/cost_views.py,sha256=oPi-RA07W4SmZjdGhqSzVNoop9U6rZPLGJImS4hyqa8,11945
 hive/cookbook/customers.py,sha256=RCr5Eo1ygTSnnHi3mwl_2iLtF4sZ60DP5J5PCXgNW1Q,81924
 hive/cookbook/dashboards.py,sha256=h-aINDn4DhvqVA6vMUPJwxhFbxMt1HKUrcOdKDL0Uhk,33600
@@ -29,6 +29,7 @@ hive/cookbook/firmware_updates.py,sha256=2N4dwLWWOq6it0f3SbLYixzAkATZ0O9v5lX-6gQ
 hive/cookbook/google.py,sha256=fxequ6Vsd7kzWyP2VV2xs8JmLUJCiw_8P7gsuYZDoM0,1430
 hive/cookbook/groups.py,sha256=VEN3qd7sEaHo8eSjRLcDlUGhlFe0T7okltNPKHsDD3U,47920
 hive/cookbook/jobs.py,sha256=VlmqbBNMx-dBMsaolHIlxJcuFTGIbPfoNOOBYhFOsnQ,4105
+hive/cookbook/last_object_status.py,sha256=DUQhy8VDG9QKBf-RBpLMKcGlptMnWwPo7rxiuNJ8-Ns,15409
 hive/cookbook/last_status.py,sha256=ewv8gKdDmxohf-btM6DNxVdywY8v_4kep9D37sfRa98,13163
 hive/cookbook/last_status_v2.py,sha256=Busbt6O1PWno81IdZRa6v8mQjDfj32Y2qMz1xFzyPJc,13178
 hive/cookbook/login.py,sha256=7LoUWuKvRTNlyejeC4gZ60hj1frAx77PzP-E0zBV0L4,22919
@@ -45,7 +46,7 @@ hive/cookbook/probe_types.py,sha256=isKPKbMr19_DVtI_0Erk4i3g6Hh_yWxOo6RbTCOkCxw,
 hive/cookbook/probes.py,sha256=PuiD6ZGMHHYBzbDQNo9J48NENQo4PLFE7PgEA4Iy7U0,25124
 hive/cookbook/probes_log_ingest.py,sha256=0D5szbqHOujPbGQ_nyZZZpob4damvWjo1FSw9iDf0fM,1661
 hive/cookbook/profile_topics.py,sha256=Wp209fmSsrEZ3jnn6AYHjX7jJ12zfFDV-T9liGUHuXI,10253
-hive/cookbook/questions.py,sha256=1qDMeAMsowO1izD1PZJXZWU4gBOofnj8xUm9nP24SL0,6862
+hive/cookbook/questions.py,sha256=VMf1WWHYFfegujy5bpI7kxVlokOpHraKW7JRppoPvYQ,8070
 hive/cookbook/reason_for_closure.py,sha256=PqDleTYc6RJmhPrJ7q-A9RgCc6GEC05x_hU9R2sXIFE,11012
 hive/cookbook/retention_rules.py,sha256=brW64MqYrl4XNYN7ZxojVDWXpdBV4fRpR7a2A1ya2zM,7958
 hive/cookbook/schedules.py,sha256=ldI-hpOx-EpCy3oSOVczk8114QL2bS_2rsjNI6TEMjc,6916
@@ -55,7 +56,7 @@ hive/cookbook/terms_and_conditions.py,sha256=cc01N2N41yAbFa5HCvY2Ur4nujSQb1VnEbs
 hive/cookbook/tree_hierarchy.py,sha256=ldJ1hMFQcghA6P2gRHheLjG74X8B6Z1JaupeAW9vg9s,23749
 hive/cookbook/tree_hierarchy_v2.py,sha256=r2aYianO9sUQa2-cec9wA3j7iWLGSLHBVSM1n3Vh8sA,23805
 hive/cookbook/ts_automata_state.py,sha256=51CXpeq3Km5Lg8OJbyEvnGRpJT9CvB3v_IV0jiXOp1Q,6260
-hive/cookbook/ts_cost_azure_raw.py,sha256=e4-bsmjOEu14dQljyNzZpEkG7-iSu1LaP9w3zbB1FHE,34075
+hive/cookbook/ts_cost_azure_raw.py,sha256=XILGs9zAePOz4mCjpbZIpjgT2yd1P0Adg8lymmwm83o,36355
 hive/cookbook/ts_cost_management.py,sha256=sGi7DgU9EUEgLSGrXy9B2PbqIOId2SckI0LnJ9r0xb0,41506
 hive/cookbook/ts_cost_management_v2.py,sha256=pZtgB1fpq50VHuSQ8c4DJtbLtnaU71HfTfnhTYTY-N0,41684
 hive/cookbook/ts_metric_status.py,sha256=AkoMOc1WTMb-dV_GTN5M5y1O0gzPVpNlV3r_wmnmIWI,6375
@@ -63,14 +64,14 @@ hive/cookbook/ts_metric_value.py,sha256=ehkjUMsAcZaA9HC0sN39gYKtXEG2xArdPsmhXWKS
 hive/cookbook/ts_ntop_flows.py,sha256=Obmn86YlFvymWMzSkQ9Lrq7OuznLf2m4T_JiC8X_qpY,17197
 hive/cookbook/ts_service_status.py,sha256=hr0heuEkEWmjvVsYVMQJpcve0hrQiY3a8w-OdfBchT8,15143
 hive/cookbook/ts_service_value.py,sha256=CAxT58Ss4cdECAv8Uuxs3UdV-CCtdVGaur3AddNAmbU,14428
-hive/cookbook/users.py,sha256=e_EdSmwmNhMo9rajxTdNizclyxMos8NpuWnyAmqfBkg,52429
+hive/cookbook/users.py,sha256=FGeHTuvcXkZN2oC-Zuj4qSsxDysLSPbg9EP0A2YbhmE,52551
 hive/cookbook/users_notifications.py,sha256=klrqR3awrwKHx6o0wpg2oLFdU0PWA2MSa41KtJQhNjw,8165
 hive/cookbook/virtual_domains.py,sha256=N3dp3pjkO-5jni3KBcCukRqcmVqAFYCDV6dgVXrHaFM,22826
-hive/cookbook/webhooks.py,sha256=xQp7gW4FQP6717d4MCOuQN2Py7nw7TFy4pl9RmkqMKs,6705
+hive/cookbook/webhooks.py,sha256=PYbA1nZqJ9p8qbKk8Ba5_WLXKgJMkXmRI1YFK70RPxQ,7047
 hive/cookbook/widget_groups.py,sha256=GY7mBh72HzI9RRMCwnmJ-fildtZ3w4BrPDUdNfNoVyk,16018
 hive/cookbook/widgets.py,sha256=nYAEwh17aMGam8EC13jUwSR_i9KuP4yYRt25F0J6Z4g,23497
-xautomata_hive-3.20.1.dist-info/LICENSE,sha256=CFT1oIPm4kciOjwep2r1LQnpATugddSy3D839fsmgFs,1065
-xautomata_hive-3.20.1.dist-info/METADATA,sha256=T8lkRiuwSP-gMGpwDTBOaFRh_MrVJ3_WfaLttuSMVxI,10747
-xautomata_hive-3.20.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-xautomata_hive-3.20.1.dist-info/top_level.txt,sha256=pLpVAuviHGk3pzaFXU-4GKttxGTGAbFoWK8JvUl1jHQ,5
-xautomata_hive-3.20.1.dist-info/RECORD,,
+xautomata_hive-3.21.0.dist-info/LICENSE,sha256=CFT1oIPm4kciOjwep2r1LQnpATugddSy3D839fsmgFs,1065
+xautomata_hive-3.21.0.dist-info/METADATA,sha256=5uc08Aguie_ZpaP5McMGIowt9KndfzIO4XjrtH2SWzM,10747
+xautomata_hive-3.21.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+xautomata_hive-3.21.0.dist-info/top_level.txt,sha256=pLpVAuviHGk3pzaFXU-4GKttxGTGAbFoWK8JvUl1jHQ,5
+xautomata_hive-3.21.0.dist-info/RECORD,,

{xautomata_hive-3.20.1.dist-info → xautomata_hive-3.21.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any