xautomata-hive 3.20.2__py3-none-any.whl → 3.22.0__py3-none-any.whl

hive/cookbook/metrics.py

@@ -6,7 +6,7 @@ class Metrics(ApiManager):
 
     def metrics(self, warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:
-        """Read Metrics
+        """Read Metrics 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.
@@ -86,55 +86,6 @@ class Metrics(ApiManager):
             **kwargs)
         return response
 
-    def metrics_v2(self, warm_start: bool = False,
-        single_page: bool = False, page_size: int = 5000,
-        kwargs: dict = None, **params) -> list:
-        """Read Metrics 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:
-            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_metric_type (string optional): additional filter - parameter
-            name (string optional): additional filter - parameter
-            description (string optional): additional filter - parameter
-            feedback_for_operator (string optional): additional filter - parameter
-            profile (string optional): additional filter - parameter
-            status (string optional): additional filter - parameter
-            extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - 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 = ['sort_by', 'null_fields',
-            'uuid_metric_type', 'name', 'description',
-            'feedback_for_operator', 'profile', 'status',
-            'extract_severity', 'skip', 'limit', 'like', 'join', 'count']
-        params.get('sort_by'), params.get('null_fields'), params.get(
-            'uuid_metric_type'), params.get('name'), params.get('description'
-            ), params.get('feedback_for_operator'), params.get('profile'
-            ), params.get('status'), params.get('extract_severity'
-            ), params.get('skip'), params.get('limit'), params.get('like'
-            ), params.get('join'), params.get('count')
-        if not self._silence_warning:
-            warning_wrong_parameters(self.metrics_v2.__name__, params,
-                official_params_list)
-        response = self.execute('GET', path=f'/metrics/v2/', single_page=
-            single_page, page_size=page_size, warm_start=warm_start, params
-            =params, **kwargs)
-        return response
-
     def metric(self, uuid: str, warm_start: bool = False,
         kwargs: dict = None, **params) -> list:
         """Read Metric

hive/cookbook/objects.py

@@ -6,7 +6,7 @@ class Objects(ApiManager):
 
     def objects(self, warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:
-        """Read Objects
+        """Read Objects 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.
@@ -83,52 +83,6 @@ class Objects(ApiManager):
             **kwargs)
         return response
 
-    def objects_v2(self, warm_start: bool = False,
-        single_page: bool = False, page_size: int = 5000,
-        kwargs: dict = None, **params) -> list:
-        """Read Objects 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:
-            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
-            name (string optional): additional filter - parameter
-            description (string optional): additional filter - parameter
-            feedback_for_operator (string optional): additional filter - parameter
-            profile (string optional): additional filter - parameter
-            status (string optional): additional filter - parameter
-            extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - 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 = ['sort_by', 'null_fields', 'name',
-            'description', 'feedback_for_operator', 'profile', 'status',
-            'extract_severity', 'skip', 'limit', 'like', 'join', 'count']
-        params.get('sort_by'), params.get('null_fields'), params.get('name'
-            ), params.get('description'), params.get('feedback_for_operator'
-            ), params.get('profile'), params.get('status'), params.get(
-            'extract_severity'), params.get('skip'), params.get('limit'
-            ), params.get('like'), params.get('join'), params.get('count')
-        if not self._silence_warning:
-            warning_wrong_parameters(self.objects_v2.__name__, params,
-                official_params_list)
-        response = self.execute('GET', path=f'/objects/v2/', single_page=
-            single_page, page_size=page_size, warm_start=warm_start, params
-            =params, **kwargs)
-        return response
-
     def object(self, uuid: str, warm_start: bool = False, kwargs: dict = None
         ) -> list:
         """Read Object

hive/cookbook/probes.py

@@ -91,7 +91,7 @@ class Probes(ApiManager):
 
     def probe(self, uuid: str, warm_start: bool = False,
         kwargs: dict = None, **params) -> list:
-        """Read Probe
+        """Read Probe V2
 
         Args:
             uuid (str, required): uuid
@@ -168,34 +168,6 @@ class Probes(ApiManager):
         response = self.execute('DELETE', path=f'/probes/{uuid}', **kwargs)
         return response
 
-    def probes_v2(self, uuid: str, warm_start: bool = False,
-        kwargs: dict = None, **params) -> list:
-        """Read Probe 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:
-            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
-            extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
-
-        Returns: list"""
-        if kwargs is None:
-            kwargs = dict()
-        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
-            =params)
-        official_params_list = ['join', 'extract_severity']
-        params.get('join'), params.get('extract_severity')
-        if not self._silence_warning:
-            warning_wrong_parameters(self.probes_v2.__name__, params,
-                official_params_list)
-        response = self.execute('GET', path=f'/probes/{uuid}/v2/',
-            warm_start=warm_start, params=params, **kwargs)
-        return response
-
     def probes_agent_put(self, uuid: str, kwargs: dict = None, **payload
         ) -> list:
         """Agent Update Probe

hive/cookbook/services.py

@@ -386,7 +386,7 @@ class Services(ApiManager):
     def services_query(self, warm_start: bool = False,
         single_page: bool = False, page_size: int = 5000,
         kwargs: dict = None, **params) -> list:
-        """Read Last Admin Status
+        """Service Query
 
         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.
@@ -432,6 +432,7 @@ class Services(ApiManager):
             service_description (string optional): additional filter - parameter
             service_status (string optional): additional filter - parameter
             service_automata_domain (string optional): additional filter - parameter
+            service_uuid_customer (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
@@ -452,8 +453,8 @@ class Services(ApiManager):
             'metric_status', 'metric_profile', 'service_uuid_parent',
             'uuid_service', 'service_profile', 'service_name',
             'service_description', 'service_status',
-            'service_automata_domain', 'skip', 'limit', 'like', 'join', 'count'
-            ]
+            'service_automata_domain', 'service_uuid_customer', 'skip',
+            'limit', 'like', 'join', 'count']
         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'
@@ -471,8 +472,9 @@ class Services(ApiManager):
             ), params.get('uuid_service'), params.get('service_profile'
             ), params.get('service_name'), params.get('service_description'
             ), params.get('service_status'), params.get(
-            'service_automata_domain'), params.get('skip'), params.get('limit'
-            ), params.get('like'), params.get('join'), params.get('count')
+            'service_automata_domain'), params.get('service_uuid_customer'
+            ), params.get('skip'), params.get('limit'), params.get('like'
+            ), params.get('join'), params.get('count')
         if not self._silence_warning:
             warning_wrong_parameters(self.services_query.__name__, params,
                 official_params_list)
@@ -484,7 +486,7 @@ class Services(ApiManager):
     def services_query_bulk(self, payload: dict = False,
         warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:
-        """Read Last Admin Status Lists
+        """Service Query Lists
 
         Args:
             payload (dict, optional): additional parameters for the API.
@@ -539,6 +541,7 @@ class Services(ApiManager):
             "service_name": "array", optional
             "service_description": "array", optional
             "service_status": "array", optional
+            "service_uuid_customer": "array", optional
            }
 
         Returns: list"""
@@ -557,6 +560,211 @@ class Services(ApiManager):
             warm_start, params=params, payload=payload, **kwargs)
         return response
 
+    def services_v2_query(self, warm_start: bool = False,
+        single_page: bool = False, page_size: int = 5000,
+        kwargs: dict = None, **params) -> list:
+        """Service Query 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:
+            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
+            service_uuid_parent (string optional): additional filter - parameter
+            uuid_service (string optional): additional filter - parameter
+            service_profile (string optional): additional filter - parameter
+            service_name (string optional): additional filter - parameter
+            service_description (string optional): additional filter - parameter
+            service_status (string optional): additional filter - parameter
+            service_automata_domain (string optional): additional filter - parameter
+            service_uuid_customer (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 = ['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', 'service_uuid_parent',
+            'uuid_service', 'service_profile', 'service_name',
+            'service_description', 'service_status',
+            'service_automata_domain', 'service_uuid_customer', 'skip',
+            'limit', 'like', 'join', 'count']
+        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('service_uuid_parent'
+            ), params.get('uuid_service'), params.get('service_profile'
+            ), params.get('service_name'), params.get('service_description'
+            ), params.get('service_status'), params.get(
+            'service_automata_domain'), params.get('service_uuid_customer'
+            ), params.get('skip'), params.get('limit'), params.get('like'
+            ), params.get('join'), params.get('count')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.services_v2_query.__name__,
+                params, official_params_list)
+        response = self.execute('GET', path=f'/services/query/v2',
+            single_page=single_page, page_size=page_size, warm_start=
+            warm_start, params=params, **kwargs)
+        return response
+
+    def services_v2_query_bulk(self, payload: dict = False,
+        warm_start: bool = False, single_page: bool = False,
+        page_size: int = 5000, kwargs: dict = None, **params) -> list:
+        """Service Query Lists V2
+
+        Args:
+            payload (dict, optional): additional parameters for the API.
+            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:
+            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
+
+        Examples:
+            payload = 
+           {
+            "uuid_customer": "array", optional
+            "customer_code": "array", optional
+            "customer_status": "array", optional
+            "uuid_site": "array", optional
+            "site_code": "array", optional
+            "site_description": "array", optional
+            "site_address": "array", optional
+            "site_zip_code": "array", optional
+            "site_city": "array", optional
+            "site_country": "array", optional
+            "site_state_province": "array", optional
+            "site_status": "array", optional
+            "uuid_group": "array", optional
+            "group_name": "array", optional
+            "group_status": "array", optional
+            "group_type": "array", optional
+            "uuid_object": "array", optional
+            "object_name": "array", optional
+            "object_status": "array", optional
+            "object_profile": "array", optional
+            "uuid_metric_type": "array", optional
+            "metric_type_name": "array", optional
+            "metric_type_status": "array", optional
+            "uuid_metric": "array", optional
+            "metric_name": "array", optional
+            "metric_status": "array", optional
+            "metric_profile": "array", optional
+            "service_uuid_parent": "array", optional
+            "uuid_service": "array", optional
+            "service_profile": "array", optional
+            "service_name": "array", optional
+            "service_description": "array", optional
+            "service_status": "array", optional
+            "service_uuid_customer": "array", optional
+           }
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_params_list = ['sort_by', 'null_fields', 'skip', 'limit',
+            'like', 'join', 'count']
+        params.get('sort_by'), params.get('null_fields'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.services_v2_query_bulk.__name__,
+                params, official_params_list)
+        response = self.execute('POST', path=f'/services/query/v2',
+            single_page=single_page, page_size=page_size, warm_start=
+            warm_start, params=params, payload=payload, **kwargs)
+        return response
+
+    def services_check_rules_create(self, params: dict = False,
+        kwargs: dict = None, **payload) -> list:
+        """Check Service Rules
+
+        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:
+            uuid_group (string optional): additional filter - parameter
+            uuid_object (string optional): additional filter - parameter
+            uuid_metric (string optional): additional filter - parameter
+            services_rules (array required): additional filter - payload
+            default_service (None required): additional filter - payload
+
+        Returns: list"""
+        if kwargs is None:
+            kwargs = dict()
+        official_payload_list = ['services_rules', 'default_service']
+        payload.get('services_rules'), payload.get('default_service')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.services_check_rules_create.
+                __name__, payload, official_payload_list)
+        response = self.execute('POST', path=f'/services/check_rules/',
+            params=params, payload=payload, **kwargs)
+        return response
+
     def services_bulk(self, payload: list, warm_start: bool = False,
         single_page: bool = False, page_size: int = 50, kwargs: dict = None,
         **params) -> list:

hive/cookbook/sites.py

@@ -6,7 +6,7 @@ class Sites(ApiManager):
 
     def sites(self, warm_start: bool = False, single_page: bool = False,
         page_size: int = 5000, kwargs: dict = None, **params) -> list:
-        """Read Sites
+        """Read Sites 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.
@@ -102,63 +102,6 @@ class Sites(ApiManager):
             payload=payload, **kwargs)
         return response
 
-    def sites_v2(self, warm_start: bool = False, single_page: bool = False,
-        page_size: int = 5000, kwargs: dict = None, **params) -> list:
-        """Read Sites 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:
-            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
-            type (string optional): additional filter - parameter
-            code (string optional): additional filter - parameter
-            description (string optional): additional filter - parameter
-            address (string optional): additional filter - parameter
-            zip_code (string optional): additional filter - parameter
-            city (string optional): additional filter - parameter
-            country (string optional): additional filter - parameter
-            notes (string optional): additional filter - parameter
-            state_province (string optional): additional filter - parameter
-            status (string optional): additional filter - parameter
-            filter_group_types (string optional): additional filter - parameter
-            extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - 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 = ['sort_by', 'null_fields', 'uuid_customer',
-            'type', 'code', 'description', 'address', 'zip_code', 'city',
-            'country', 'notes', 'state_province', 'status',
-            'filter_group_types', 'extract_severity', 'skip', 'limit',
-            'like', 'join', 'count']
-        params.get('sort_by'), params.get('null_fields'), params.get(
-            'uuid_customer'), params.get('type'), params.get('code'
-            ), params.get('description'), params.get('address'), params.get(
-            'zip_code'), params.get('city'), params.get('country'), params.get(
-            'notes'), params.get('state_province'), params.get('status'
-            ), params.get('filter_group_types'), params.get('extract_severity'
-            ), params.get('skip'), params.get('limit'), params.get('like'
-            ), params.get('join'), params.get('count')
-        if not self._silence_warning:
-            warning_wrong_parameters(self.sites_v2.__name__, params,
-                official_params_list)
-        response = self.execute('GET', path=f'/sites/v2/', single_page=
-            single_page, page_size=page_size, warm_start=warm_start, params
-            =params, **kwargs)
-        return response
-
     def site(self, uuid: str, warm_start: bool = False, kwargs: dict = None,
         **params) -> list:
         """Read Site

hive/cookbook/webhooks.py

@@ -114,17 +114,31 @@ class Webhooks(ApiManager):
             payload, **kwargs)
         return response
 
-    def webhooks_create_webhook_type(self, webhook_type: str,
-        kwargs: dict = None) -> list:
+    def webhooks_create_webhook_type(self, payload: list, webhook_type: str,
+        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
+        **params) -> list:
         """Post Webhook
 
         Args:
+            payload (list[dict], optional): List dict to create.
             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.
+            **params: additional parameters for the API.
+
+        Keyword Args:
+            xa-auth-token (string required): additional filter - parameter
 
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['xa-auth-token']
+        params.get('xa-auth-token')
+        if not self._silence_warning:
+            warning_wrong_parameters(self.webhooks_create.__name__, params,
+                official_params_list)
         response = self.execute('POST', path=f'/webhooks/{webhook_type}',
-            **kwargs)
+            single_page=single_page, page_size=page_size, params=params,
+            payload=payload, **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.2'
+version = '3.22.0'

{xautomata_hive-3.20.2.dist-info → xautomata_hive-3.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: xautomata-hive
-Version: 3.20.2
+Version: 3.22.0
 Home-page: https://github.com/sherlogic/xautomata-hive.git
 Author: Enrico Ferro - Andrea Jacassi
 Author-email: 
@@ -11,6 +11,13 @@ License-File: LICENSE
 Requires-Dist: urllib3==2.0.4
 Requires-Dist: requests==2.31.0
 Requires-Dist: tqdm==4.64.1
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
 
 # Xautomata API
 Pacchetto che fornisca una interfaccia semplice per usare le API di Xautomata in python