xautomata-hive 3.0.3__py3-none-any.whl → 3.2.0__py3-none-any.whl

hive/cookbook/dashboards.py

@@ -1,4 +1,4 @@
-from hive.api import ApiManager, handling_single_page_methods
+from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
 
 
 class Dashboards(ApiManager):
@@ -33,6 +33,18 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['sort_by', 'null_fields',
+            'uuid_origin_dashboard', 'name', 'description', 'type',
+            'username', 'profile', 'priority', 'refresh_interval', 'skip',
+            'limit', 'like', 'join', 'count']
+        params.get('sort_by'), params.get('null_fields'), params.get(
+            'uuid_origin_dashboard'), params.get('name'), params.get(
+            'description'), params.get('type'), params.get('username'
+            ), params.get('profile'), params.get('priority'), params.get(
+            'refresh_interval'), params.get('skip'), params.get('limit'
+            ), params.get('like'), params.get('join'), params.get('count')
+        warning_wrong_parameters(self.dashboards.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dashboards/', single_page=
             single_page, page_size=page_size, warm_start=warm_start, params
             =params, **kwargs)
@@ -56,6 +68,15 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['name', 'type', 'username', 'description',
+            'profile', 'priority', 'refresh_interval', 'image_name',
+            'uuid_origin_dashboard']
+        payload.get('name'), payload.get('type'), payload.get('username'
+            ), payload.get('description'), payload.get('profile'), payload.get(
+            'priority'), payload.get('refresh_interval'), payload.get(
+            'image_name'), payload.get('uuid_origin_dashboard')
+        warning_wrong_parameters(self.dashboards_create.__name__, payload,
+            official_payload_list)
         response = self.execute('POST', path=f'/dashboards/', payload=
             payload, **kwargs)
         return response
@@ -75,6 +96,10 @@ class Dashboards(ApiManager):
             kwargs = dict()
         kwargs, params = handling_single_page_methods(kwargs=kwargs, params
             =params)
+        official_params_list = ['join']
+        params.get('join')
+        warning_wrong_parameters(self.dashboard.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dashboards/{uuid}',
             warm_start=warm_start, params=params, **kwargs)
         return response
@@ -98,6 +123,14 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['name', 'type', 'username', 'description',
+            'profile', 'priority', 'refresh_interval', 'image_name']
+        payload.get('name'), payload.get('type'), payload.get('username'
+            ), payload.get('description'), payload.get('profile'), payload.get(
+            'priority'), payload.get('refresh_interval'), payload.get(
+            'image_name')
+        warning_wrong_parameters(self.dashboards_put.__name__, payload,
+            official_payload_list)
         response = self.execute('PUT', path=f'/dashboards/{uuid}', payload=
             payload, **kwargs)
         return response
@@ -139,6 +172,10 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['image']
+        payload.get('image')
+        warning_wrong_parameters(self.dashboards_image_put.__name__,
+            payload, official_payload_list)
         response = self.execute('PUT', path=f'/dashboards/{uuid}/image',
             payload=payload, **kwargs)
         return response
@@ -156,6 +193,7 @@ class Dashboards(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (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
@@ -164,6 +202,13 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
+            'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dashboards_users.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dashboards/{uuid}/users',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -210,6 +255,7 @@ class Dashboards(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (string optional): additional filter - parameter
             index (integer optional): additional filter - parameter
             width (integer optional): additional filter - parameter
             height (integer optional): additional filter - parameter
@@ -223,6 +269,15 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'index', 'width',
+            'height', 'grid_x', 'grid_y', 'skip', 'limit', 'like', 'join',
+            'count']
+        params.get('not_in'), params.get('name'), params.get('index'
+            ), params.get('width'), params.get('height'), params.get('grid_x'
+            ), params.get('grid_y'), params.get('skip'), params.get('limit'
+            ), params.get('like'), params.get('join'), params.get('count')
+        warning_wrong_parameters(self.dashboards_widgets.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dashboards/{uuid}/widgets',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -246,6 +301,13 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['index', 'width', 'height', 'grid_x',
+            'grid_y', 'settings']
+        payload.get('index'), payload.get('width'), payload.get('height'
+            ), payload.get('grid_x'), payload.get('grid_y'), payload.get(
+            'settings')
+        warning_wrong_parameters(self.dashboards_widgets_create.__name__,
+            payload, official_payload_list)
         response = self.execute('POST', path=
             f'/dashboards/{uuid}/widgets/{uuid_widget}', payload=payload,
             **kwargs)
@@ -268,6 +330,13 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['index', 'width', 'height', 'grid_x',
+            'grid_y', 'settings']
+        payload.get('index'), payload.get('width'), payload.get('height'
+            ), payload.get('grid_x'), payload.get('grid_y'), payload.get(
+            'settings')
+        warning_wrong_parameters(self.dashboards_dashboard_widget_put.
+            __name__, payload, official_payload_list)
         response = self.execute('PUT', path=
             f'/dashboards/dashboard_widget/{uuid}', payload=payload, **kwargs)
         return response
@@ -309,6 +378,10 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['join']
+        params.get('join')
+        warning_wrong_parameters(self.dashboards_bulk.__name__, params,
+            official_params_list)
         response = self.execute('POST', path=f'/dashboards/bulk/read/',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, payload=payload, **kwargs)
@@ -346,6 +419,10 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['best_effort']
+        params.get('best_effort')
+        warning_wrong_parameters(self.dashboards_create_bulk.__name__,
+            params, official_params_list)
         response = self.execute('POST', path=f'/dashboards/bulk/create/',
             single_page=single_page, page_size=page_size, params=params,
             payload=payload, **kwargs)
@@ -406,6 +483,10 @@ class Dashboards(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['best_effort']
+        params.get('best_effort')
+        warning_wrong_parameters(self.dashboards_widgets_create_bulk.
+            __name__, params, official_params_list)
         response = self.execute('POST', path=
             f'/dashboards/bulk/create/widgets', single_page=single_page,
             page_size=page_size, params=params, payload=payload, **kwargs)

hive/cookbook/dispatchers.py

@@ -1,4 +1,4 @@
-from hive.api import ApiManager, handling_single_page_methods
+from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
 
 
 class Dispatchers(ApiManager):
@@ -32,6 +32,19 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['sort_by', 'null_fields',
+            'uuid_notification_provider', 'uuid_calendar', 'uuid_message',
+            'uuid_opening_reason', 'uuid_reason_for_closure', 'code',
+            'description', 'skip', 'limit', 'like', 'join', 'count']
+        params.get('sort_by'), params.get('null_fields'), params.get(
+            'uuid_notification_provider'), params.get('uuid_calendar'
+            ), params.get('uuid_message'), params.get('uuid_opening_reason'
+            ), params.get('uuid_reason_for_closure'), params.get('code'
+            ), params.get('description'), params.get('skip'), params.get(
+            'limit'), params.get('like'), params.get('join'), params.get(
+            'count')
+        warning_wrong_parameters(self.dispatchers.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/', single_page=
             single_page, page_size=page_size, warm_start=warm_start, params
             =params, **kwargs)
@@ -59,6 +72,19 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['uuid_notification_provider',
+            'uuid_calendar', 'uuid_message', 'uuid_opening_reason',
+            'uuid_reason_for_closure', 'code', 'description', 'delay',
+            'status', 'country', 'state_province', 'data_profile',
+            'remember_it']
+        payload.get('uuid_notification_provider'), payload.get('uuid_calendar'
+            ), payload.get('uuid_message'), payload.get('uuid_opening_reason'
+            ), payload.get('uuid_reason_for_closure'), payload.get('code'
+            ), payload.get('description'), payload.get('delay'), payload.get(
+            'status'), payload.get('country'), payload.get('state_province'
+            ), payload.get('data_profile'), payload.get('remember_it')
+        warning_wrong_parameters(self.dispatchers_create.__name__, payload,
+            official_payload_list)
         response = self.execute('POST', path=f'/dispatchers/', payload=
             payload, **kwargs)
         return response
@@ -78,6 +104,10 @@ class Dispatchers(ApiManager):
             kwargs = dict()
         kwargs, params = handling_single_page_methods(kwargs=kwargs, params
             =params)
+        official_params_list = ['join']
+        params.get('join')
+        warning_wrong_parameters(self.dispatcher.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/{uuid}',
             warm_start=warm_start, params=params, **kwargs)
         return response
@@ -106,6 +136,19 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['uuid_notification_provider',
+            'uuid_calendar', 'uuid_message', 'uuid_opening_reason',
+            'uuid_reason_for_closure', 'code', 'description', 'delay',
+            'status', 'country', 'state_province', 'data_profile',
+            'remember_it']
+        payload.get('uuid_notification_provider'), payload.get('uuid_calendar'
+            ), payload.get('uuid_message'), payload.get('uuid_opening_reason'
+            ), payload.get('uuid_reason_for_closure'), payload.get('code'
+            ), payload.get('description'), payload.get('delay'), payload.get(
+            'status'), payload.get('country'), payload.get('state_province'
+            ), payload.get('data_profile'), payload.get('remember_it')
+        warning_wrong_parameters(self.dispatchers_put.__name__, payload,
+            official_payload_list)
         response = self.execute('PUT', path=f'/dispatchers/{uuid}', payload
             =payload, **kwargs)
         return response
@@ -135,6 +178,7 @@ class Dispatchers(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (string optional): additional filter - parameter
             send_email (boolean optional): additional filter - parameter
             role_email (None optional): additional filter - parameter
             send_sms (boolean optional): additional filter - parameter
@@ -146,6 +190,14 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'send_email',
+            'role_email', 'send_sms', 'skip', 'limit', 'like', 'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('send_email'
+            ), params.get('role_email'), params.get('send_sms'), params.get(
+            'skip'), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dispatchers_contacts.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/{uuid}/contacts',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -167,6 +219,12 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['send_email', 'role_email', 'send_sms',
+            'endpoint']
+        payload.get('send_email'), payload.get('role_email'), payload.get(
+            'send_sms'), payload.get('endpoint')
+        warning_wrong_parameters(self.dispatchers_contacts_put.__name__,
+            payload, official_payload_list)
         response = self.execute('PUT', path=
             f'/dispatchers/{uuid}/contacts/{uuid_contact}', payload=payload,
             **kwargs)
@@ -188,6 +246,12 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_payload_list = ['send_email', 'role_email', 'send_sms',
+            'endpoint']
+        payload.get('send_email'), payload.get('role_email'), payload.get(
+            'send_sms'), payload.get('endpoint')
+        warning_wrong_parameters(self.dispatchers_contacts_create.__name__,
+            payload, official_payload_list)
         response = self.execute('POST', path=
             f'/dispatchers/{uuid}/contacts/{uuid_contact}', payload=payload,
             **kwargs)
@@ -220,6 +284,7 @@ class Dispatchers(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (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
@@ -228,6 +293,13 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
+            'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dispatchers_groups.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/{uuid}/groups',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -274,6 +346,7 @@ class Dispatchers(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (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
@@ -282,6 +355,13 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
+            'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dispatchers_objects.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/{uuid}/objects',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -328,6 +408,7 @@ class Dispatchers(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (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
@@ -336,6 +417,13 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
+            'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dispatchers_metrics.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/{uuid}/metrics',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -382,6 +470,7 @@ class Dispatchers(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (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
@@ -390,6 +479,13 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
+            'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dispatchers_metric_types.__name__,
+            params, official_params_list)
         response = self.execute('GET', path=
             f'/dispatchers/{uuid}/metric_types', single_page=single_page,
             page_size=page_size, warm_start=warm_start, params=params, **kwargs
@@ -437,6 +533,7 @@ class Dispatchers(ApiManager):
             **params: additional parameters for the API.
         Keyword Args:
             not_in (boolean optional): additional filter - parameter
+            name (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
@@ -445,6 +542,13 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
+            'join', 'count']
+        params.get('not_in'), params.get('name'), params.get('skip'
+            ), params.get('limit'), params.get('like'), params.get('join'
+            ), params.get('count')
+        warning_wrong_parameters(self.dispatchers_services.__name__, params,
+            official_params_list)
         response = self.execute('GET', path=f'/dispatchers/{uuid}/services',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, **kwargs)
@@ -502,6 +606,10 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['join']
+        params.get('join')
+        warning_wrong_parameters(self.dispatchers_bulk.__name__, params,
+            official_params_list)
         response = self.execute('POST', path=f'/dispatchers/bulk/read/',
             single_page=single_page, page_size=page_size, warm_start=
             warm_start, params=params, payload=payload, **kwargs)
@@ -543,6 +651,10 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['best_effort']
+        params.get('best_effort')
+        warning_wrong_parameters(self.dispatchers_create_bulk.__name__,
+            params, official_params_list)
         response = self.execute('POST', path=f'/dispatchers/bulk/create/',
             single_page=single_page, page_size=page_size, params=params,
             payload=payload, **kwargs)
@@ -601,6 +713,10 @@ class Dispatchers(ApiManager):
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
+        official_params_list = ['best_effort']
+        params.get('best_effort')
+        warning_wrong_parameters(self.dispatchers_contacts_create_bulk.
+            __name__, params, official_params_list)
         response = self.execute('POST', path=
             f'/dispatchers/bulk/create/contacts', single_page=single_page,
             page_size=page_size, params=params, payload=payload, **kwargs)