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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. hive/api.py +124 -43
  2. hive/cookbook/acl_docs.py +1 -1
  3. hive/cookbook/acl_overrides.py +22 -1
  4. hive/cookbook/analytics.py +11 -1
  5. hive/cookbook/anomalies.py +30 -1
  6. hive/cookbook/calendars.py +95 -1
  7. hive/cookbook/contacts.py +114 -1
  8. hive/cookbook/customers.py +293 -7
  9. hive/cookbook/dashboards.py +82 -1
  10. hive/cookbook/dispatchers.py +117 -1
  11. hive/cookbook/downtimes.py +100 -1
  12. hive/cookbook/external_tickets.py +117 -1
  13. hive/cookbook/firmware_updates.py +20 -1
  14. hive/cookbook/groups.py +88 -1
  15. hive/cookbook/last_status.py +48 -2
  16. hive/cookbook/login.py +163 -1
  17. hive/cookbook/messages.py +35 -1
  18. hive/cookbook/metric_ingest.py +1 -1
  19. hive/cookbook/metric_types.py +71 -1
  20. hive/cookbook/metrics.py +77 -1
  21. hive/cookbook/notification_provider_types.py +32 -1
  22. hive/cookbook/notification_providers.py +28 -1
  23. hive/cookbook/objects.py +95 -1
  24. hive/cookbook/opening_reasons.py +33 -1
  25. hive/cookbook/probe_types.py +31 -1
  26. hive/cookbook/probes.py +70 -1
  27. hive/cookbook/probes_log_ingest.py +5 -1
  28. hive/cookbook/profile_topics.py +24 -1
  29. hive/cookbook/reason_for_closure.py +36 -6
  30. hive/cookbook/retention_rules.py +30 -1
  31. hive/cookbook/schedules.py +20 -1
  32. hive/cookbook/services.py +114 -2
  33. hive/cookbook/sites.py +93 -1
  34. hive/cookbook/tree_hierarchy.py +89 -1
  35. hive/cookbook/ts_cost_azure_raw.py +154 -1
  36. hive/cookbook/ts_cost_management.py +136 -114
  37. hive/cookbook/ts_metric_status.py +20 -1
  38. hive/cookbook/ts_metric_value.py +19 -1
  39. hive/cookbook/ts_ntop_flows.py +25 -1
  40. hive/cookbook/ts_service_status.py +48 -2
  41. hive/cookbook/ts_service_value.py +43 -1
  42. hive/cookbook/users.py +174 -3
  43. hive/cookbook/users_notifications.py +109 -0
  44. hive/cookbook/virtual_domains.py +47 -1
  45. hive/cookbook/webhooks.py +21 -1
  46. hive/cookbook/widget_groups.py +39 -1
  47. hive/cookbook/widgets.py +60 -1
  48. hive/version.py +1 -1
  49. {xautomata_hive-3.0.3.dist-info → xautomata_hive-3.2.0.dist-info}/METADATA +1 -1
  50. xautomata_hive-3.2.0.dist-info/RECORD +58 -0
  51. {xautomata_hive-3.0.3.dist-info → xautomata_hive-3.2.0.dist-info}/WHEEL +1 -1
  52. xautomata_hive-3.0.3.dist-info/RECORD +0 -57
  53. {xautomata_hive-3.0.3.dist-info → xautomata_hive-3.2.0.dist-info}/LICENSE +0 -0
  54. {xautomata_hive-3.0.3.dist-info → xautomata_hive-3.2.0.dist-info}/top_level.txt +0 -0
hive/cookbook/objects.py CHANGED
@@ -1,4 +1,4 @@
1
- from hive.api import ApiManager, handling_single_page_methods
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
2
 
3
3
 
4
4
  class Objects(ApiManager):
@@ -30,6 +30,16 @@ class Objects(ApiManager):
30
30
  Returns: list"""
31
31
  if kwargs is None:
32
32
  kwargs = dict()
33
+ official_params_list = ['sort_by', 'null_fields', 'name',
34
+ 'description', 'feedback_for_operator', 'profile', 'status',
35
+ 'extract_severity', 'skip', 'limit', 'like', 'join', 'count']
36
+ params.get('sort_by'), params.get('null_fields'), params.get('name'
37
+ ), params.get('description'), params.get('feedback_for_operator'
38
+ ), params.get('profile'), params.get('status'), params.get(
39
+ 'extract_severity'), params.get('skip'), params.get('limit'
40
+ ), params.get('like'), params.get('join'), params.get('count')
41
+ warning_wrong_parameters(self.objects.__name__, params,
42
+ official_params_list)
33
43
  response = self.execute('GET', path=f'/objects/', single_page=
34
44
  single_page, page_size=page_size, warm_start=warm_start, params
35
45
  =params, **kwargs)
@@ -52,6 +62,15 @@ class Objects(ApiManager):
52
62
  Returns: list"""
53
63
  if kwargs is None:
54
64
  kwargs = dict()
65
+ official_payload_list = ['name', 'description',
66
+ 'feedback_for_operator', 'ip_cidr', 'profile', 'data_profile',
67
+ 'automata_domain', 'status']
68
+ payload.get('name'), payload.get('description'), payload.get(
69
+ 'feedback_for_operator'), payload.get('ip_cidr'), payload.get(
70
+ 'profile'), payload.get('data_profile'), payload.get(
71
+ 'automata_domain'), payload.get('status')
72
+ warning_wrong_parameters(self.objects_create.__name__, payload,
73
+ official_payload_list)
55
74
  response = self.execute('POST', path=f'/objects/', payload=payload,
56
75
  **kwargs)
57
76
  return response
@@ -92,6 +111,15 @@ class Objects(ApiManager):
92
111
  Returns: list"""
93
112
  if kwargs is None:
94
113
  kwargs = dict()
114
+ official_payload_list = ['name', 'description',
115
+ 'feedback_for_operator', 'ip_cidr', 'profile', 'data_profile',
116
+ 'automata_domain', 'status']
117
+ payload.get('name'), payload.get('description'), payload.get(
118
+ 'feedback_for_operator'), payload.get('ip_cidr'), payload.get(
119
+ 'profile'), payload.get('data_profile'), payload.get(
120
+ 'automata_domain'), payload.get('status')
121
+ warning_wrong_parameters(self.objects_put.__name__, payload,
122
+ official_payload_list)
95
123
  response = self.execute('PUT', path=f'/objects/{uuid}', params=
96
124
  params, payload=payload, **kwargs)
97
125
  return response
@@ -120,6 +148,7 @@ class Objects(ApiManager):
120
148
  **params: additional parameters for the API.
121
149
  Keyword Args:
122
150
  not_in (boolean optional): additional filter - parameter
151
+ name (string optional): additional filter - parameter
123
152
  skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
124
153
  limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
125
154
  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
@@ -128,6 +157,13 @@ class Objects(ApiManager):
128
157
  Returns: list"""
129
158
  if kwargs is None:
130
159
  kwargs = dict()
160
+ official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
161
+ 'join', 'count']
162
+ params.get('not_in'), params.get('name'), params.get('skip'
163
+ ), params.get('limit'), params.get('like'), params.get('join'
164
+ ), params.get('count')
165
+ warning_wrong_parameters(self.objects_metric_types.__name__, params,
166
+ official_params_list)
131
167
  response = self.execute('GET', path=f'/objects/{uuid}/metric_types',
132
168
  single_page=single_page, page_size=page_size, warm_start=
133
169
  warm_start, params=params, **kwargs)
@@ -154,6 +190,12 @@ class Objects(ApiManager):
154
190
  Returns: list"""
155
191
  if kwargs is None:
156
192
  kwargs = dict()
193
+ official_params_list = ['not_in', 'skip', 'limit', 'like', 'join',
194
+ 'count']
195
+ params.get('not_in'), params.get('skip'), params.get('limit'
196
+ ), params.get('like'), params.get('join'), params.get('count')
197
+ warning_wrong_parameters(self.objects_hosted.__name__, params,
198
+ official_params_list)
157
199
  response = self.execute('GET', path=f'/objects/{uuid}/hosted',
158
200
  single_page=single_page, page_size=page_size, warm_start=
159
201
  warm_start, params=params, **kwargs)
@@ -172,6 +214,7 @@ class Objects(ApiManager):
172
214
  **params: additional parameters for the API.
173
215
  Keyword Args:
174
216
  not_in (boolean optional): additional filter - parameter
217
+ name (string optional): additional filter - parameter
175
218
  skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
176
219
  limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
177
220
  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
@@ -180,6 +223,13 @@ class Objects(ApiManager):
180
223
  Returns: list"""
181
224
  if kwargs is None:
182
225
  kwargs = dict()
226
+ official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
227
+ 'join', 'count']
228
+ params.get('not_in'), params.get('name'), params.get('skip'
229
+ ), params.get('limit'), params.get('like'), params.get('join'
230
+ ), params.get('count')
231
+ warning_wrong_parameters(self.objects_groups.__name__, params,
232
+ official_params_list)
183
233
  response = self.execute('GET', path=f'/objects/{uuid}/groups',
184
234
  single_page=single_page, page_size=page_size, warm_start=
185
235
  warm_start, params=params, **kwargs)
@@ -226,6 +276,7 @@ class Objects(ApiManager):
226
276
  **params: additional parameters for the API.
227
277
  Keyword Args:
228
278
  not_in (boolean optional): additional filter - parameter
279
+ name (string optional): additional filter - parameter
229
280
  skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
230
281
  limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
231
282
  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
@@ -234,6 +285,13 @@ class Objects(ApiManager):
234
285
  Returns: list"""
235
286
  if kwargs is None:
236
287
  kwargs = dict()
288
+ official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
289
+ 'join', 'count']
290
+ params.get('not_in'), params.get('name'), params.get('skip'
291
+ ), params.get('limit'), params.get('like'), params.get('join'
292
+ ), params.get('count')
293
+ warning_wrong_parameters(self.objects_probes.__name__, params,
294
+ official_params_list)
237
295
  response = self.execute('GET', path=f'/objects/{uuid}/probes',
238
296
  single_page=single_page, page_size=page_size, warm_start=
239
297
  warm_start, params=params, **kwargs)
@@ -280,6 +338,7 @@ class Objects(ApiManager):
280
338
  **params: additional parameters for the API.
281
339
  Keyword Args:
282
340
  not_in (boolean optional): additional filter - parameter
341
+ code (string optional): additional filter - parameter
283
342
  active_at_timestamp (string optional): additional filter - parameter
284
343
  skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
285
344
  limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
@@ -289,6 +348,13 @@ class Objects(ApiManager):
289
348
  Returns: list"""
290
349
  if kwargs is None:
291
350
  kwargs = dict()
351
+ official_params_list = ['not_in', 'code', 'active_at_timestamp',
352
+ 'skip', 'limit', 'like', 'join', 'count']
353
+ params.get('not_in'), params.get('code'), params.get(
354
+ 'active_at_timestamp'), params.get('skip'), params.get('limit'
355
+ ), params.get('like'), params.get('join'), params.get('count')
356
+ warning_wrong_parameters(self.objects_downtimes.__name__, params,
357
+ official_params_list)
292
358
  response = self.execute('GET', path=f'/objects/{uuid}/downtimes',
293
359
  single_page=single_page, page_size=page_size, warm_start=
294
360
  warm_start, params=params, **kwargs)
@@ -335,6 +401,7 @@ class Objects(ApiManager):
335
401
  **params: additional parameters for the API.
336
402
  Keyword Args:
337
403
  not_in (boolean optional): additional filter - parameter
404
+ code (string optional): additional filter - parameter
338
405
  active_at_timestamp (string optional): additional filter - parameter
339
406
  skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
340
407
  limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
@@ -344,6 +411,13 @@ class Objects(ApiManager):
344
411
  Returns: list"""
345
412
  if kwargs is None:
346
413
  kwargs = dict()
414
+ official_params_list = ['not_in', 'code', 'active_at_timestamp',
415
+ 'skip', 'limit', 'like', 'join', 'count']
416
+ params.get('not_in'), params.get('code'), params.get(
417
+ 'active_at_timestamp'), params.get('skip'), params.get('limit'
418
+ ), params.get('like'), params.get('join'), params.get('count')
419
+ warning_wrong_parameters(self.objects_dispatchers.__name__, params,
420
+ official_params_list)
347
421
  response = self.execute('GET', path=f'/objects/{uuid}/dispatchers',
348
422
  single_page=single_page, page_size=page_size, warm_start=
349
423
  warm_start, params=params, **kwargs)
@@ -401,6 +475,10 @@ class Objects(ApiManager):
401
475
  Returns: list"""
402
476
  if kwargs is None:
403
477
  kwargs = dict()
478
+ official_params_list = ['join']
479
+ params.get('join')
480
+ warning_wrong_parameters(self.objects_bulk.__name__, params,
481
+ official_params_list)
404
482
  response = self.execute('POST', path=f'/objects/bulk/read/',
405
483
  single_page=single_page, page_size=page_size, warm_start=
406
484
  warm_start, params=params, payload=payload, **kwargs)
@@ -462,6 +540,10 @@ class Objects(ApiManager):
462
540
  Returns: list"""
463
541
  if kwargs is None:
464
542
  kwargs = dict()
543
+ official_params_list = ['best_effort']
544
+ params.get('best_effort')
545
+ warning_wrong_parameters(self.objects_create_bulk.__name__, params,
546
+ official_params_list)
465
547
  response = self.execute('POST', path=f'/objects/bulk/create/',
466
548
  single_page=single_page, page_size=page_size, params=params,
467
549
  payload=payload, **kwargs)
@@ -515,6 +597,10 @@ class Objects(ApiManager):
515
597
  Returns: list"""
516
598
  if kwargs is None:
517
599
  kwargs = dict()
600
+ official_params_list = ['best_effort']
601
+ params.get('best_effort')
602
+ warning_wrong_parameters(self.objects_groups_create_bulk.__name__,
603
+ params, official_params_list)
518
604
  response = self.execute('POST', path=f'/objects/bulk/create/groups',
519
605
  single_page=single_page, page_size=page_size, params=params,
520
606
  payload=payload, **kwargs)
@@ -572,6 +658,10 @@ class Objects(ApiManager):
572
658
  Returns: list"""
573
659
  if kwargs is None:
574
660
  kwargs = dict()
661
+ official_params_list = ['best_effort']
662
+ params.get('best_effort')
663
+ warning_wrong_parameters(self.objects_downtimes_create_bulk.
664
+ __name__, params, official_params_list)
575
665
  response = self.execute('POST', path=
576
666
  f'/objects/bulk/create/downtimes', single_page=single_page,
577
667
  page_size=page_size, params=params, payload=payload, **kwargs)
@@ -629,6 +719,10 @@ class Objects(ApiManager):
629
719
  Returns: list"""
630
720
  if kwargs is None:
631
721
  kwargs = dict()
722
+ official_params_list = ['best_effort']
723
+ params.get('best_effort')
724
+ warning_wrong_parameters(self.objects_probes_create_bulk.__name__,
725
+ params, official_params_list)
632
726
  response = self.execute('POST', path=f'/objects/bulk/create/probes',
633
727
  single_page=single_page, page_size=page_size, params=params,
634
728
  payload=payload, **kwargs)
@@ -1,4 +1,4 @@
1
- from hive.api import ApiManager, handling_single_page_methods
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
2
 
3
3
 
4
4
  class OpeningReasons(ApiManager):
@@ -31,6 +31,16 @@ class OpeningReasons(ApiManager):
31
31
  Returns: list"""
32
32
  if kwargs is None:
33
33
  kwargs = dict()
34
+ official_params_list = ['sort_by', 'null_fields', 'code',
35
+ 'description', 'severity', 'sla_l1', 'sla_l2', 'sla_l3', 'skip',
36
+ 'limit', 'like', 'join', 'count']
37
+ params.get('sort_by'), params.get('null_fields'), params.get('code'
38
+ ), params.get('description'), params.get('severity'), params.get(
39
+ 'sla_l1'), params.get('sla_l2'), params.get('sla_l3'), params.get(
40
+ 'skip'), params.get('limit'), params.get('like'), params.get('join'
41
+ ), params.get('count')
42
+ warning_wrong_parameters(self.opening_reasons.__name__, params,
43
+ official_params_list)
34
44
  response = self.execute('GET', path=f'/opening_reasons/',
35
45
  single_page=single_page, page_size=page_size, warm_start=
36
46
  warm_start, params=params, **kwargs)
@@ -51,6 +61,13 @@ class OpeningReasons(ApiManager):
51
61
  Returns: list"""
52
62
  if kwargs is None:
53
63
  kwargs = dict()
64
+ official_payload_list = ['code', 'description', 'severity',
65
+ 'sla_l1', 'sla_l2', 'sla_l3']
66
+ payload.get('code'), payload.get('description'), payload.get('severity'
67
+ ), payload.get('sla_l1'), payload.get('sla_l2'), payload.get(
68
+ 'sla_l3')
69
+ warning_wrong_parameters(self.opening_reasons_create.__name__,
70
+ payload, official_payload_list)
54
71
  response = self.execute('POST', path=f'/opening_reasons/', payload=
55
72
  payload, **kwargs)
56
73
  return response
@@ -86,6 +103,13 @@ class OpeningReasons(ApiManager):
86
103
  Returns: list"""
87
104
  if kwargs is None:
88
105
  kwargs = dict()
106
+ official_payload_list = ['code', 'description', 'severity',
107
+ 'sla_l1', 'sla_l2', 'sla_l3']
108
+ payload.get('code'), payload.get('description'), payload.get('severity'
109
+ ), payload.get('sla_l1'), payload.get('sla_l2'), payload.get(
110
+ 'sla_l3')
111
+ warning_wrong_parameters(self.opening_reasons_put.__name__, payload,
112
+ official_payload_list)
89
113
  response = self.execute('PUT', path=f'/opening_reasons/{uuid}',
90
114
  payload=payload, **kwargs)
91
115
  return response
@@ -126,6 +150,10 @@ class OpeningReasons(ApiManager):
126
150
  Returns: list"""
127
151
  if kwargs is None:
128
152
  kwargs = dict()
153
+ official_params_list = ['join']
154
+ params.get('join')
155
+ warning_wrong_parameters(self.opening_reasons_bulk.__name__, params,
156
+ official_params_list)
129
157
  response = self.execute('POST', path=f'/opening_reasons/bulk/read/',
130
158
  single_page=single_page, page_size=page_size, warm_start=
131
159
  warm_start, params=params, payload=payload, **kwargs)
@@ -160,6 +188,10 @@ class OpeningReasons(ApiManager):
160
188
  Returns: list"""
161
189
  if kwargs is None:
162
190
  kwargs = dict()
191
+ official_params_list = ['best_effort']
192
+ params.get('best_effort')
193
+ warning_wrong_parameters(self.opening_reasons_create_bulk.__name__,
194
+ params, official_params_list)
163
195
  response = self.execute('POST', path=
164
196
  f'/opening_reasons/bulk/create/', single_page=single_page,
165
197
  page_size=page_size, params=params, payload=payload, **kwargs)
@@ -1,4 +1,4 @@
1
- from hive.api import ApiManager, handling_single_page_methods
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
2
 
3
3
 
4
4
  class ProbeTypes(ApiManager):
@@ -27,6 +27,13 @@ class ProbeTypes(ApiManager):
27
27
  Returns: list"""
28
28
  if kwargs is None:
29
29
  kwargs = dict()
30
+ official_params_list = ['sort_by', 'null_fields', 'app_code',
31
+ 'app_name', 'skip', 'limit', 'like', 'join', 'count']
32
+ params.get('sort_by'), params.get('null_fields'), params.get('app_code'
33
+ ), params.get('app_name'), params.get('skip'), params.get('limit'
34
+ ), params.get('like'), params.get('join'), params.get('count')
35
+ warning_wrong_parameters(self.probe_types.__name__, params,
36
+ official_params_list)
30
37
  response = self.execute('GET', path=f'/probe_types/', single_page=
31
38
  single_page, page_size=page_size, warm_start=warm_start, params
32
39
  =params, **kwargs)
@@ -44,6 +51,11 @@ class ProbeTypes(ApiManager):
44
51
  Returns: list"""
45
52
  if kwargs is None:
46
53
  kwargs = dict()
54
+ official_payload_list = ['app_code', 'app_name', 'endpoint']
55
+ payload.get('app_code'), payload.get('app_name'), payload.get(
56
+ 'endpoint')
57
+ warning_wrong_parameters(self.probe_types_create.__name__, payload,
58
+ official_payload_list)
47
59
  response = self.execute('POST', path=f'/probe_types/', payload=
48
60
  payload, **kwargs)
49
61
  return response
@@ -76,6 +88,11 @@ class ProbeTypes(ApiManager):
76
88
  Returns: list"""
77
89
  if kwargs is None:
78
90
  kwargs = dict()
91
+ official_payload_list = ['app_code', 'app_name', 'endpoint']
92
+ payload.get('app_code'), payload.get('app_name'), payload.get(
93
+ 'endpoint')
94
+ warning_wrong_parameters(self.probe_types_put.__name__, payload,
95
+ official_payload_list)
79
96
  response = self.execute('PUT', path=f'/probe_types/{uuid}', payload
80
97
  =payload, **kwargs)
81
98
  return response
@@ -112,6 +129,11 @@ class ProbeTypes(ApiManager):
112
129
  Returns: list"""
113
130
  if kwargs is None:
114
131
  kwargs = dict()
132
+ official_params_list = ['skip', 'limit', 'like', 'join', 'count']
133
+ params.get('skip'), params.get('limit'), params.get('like'
134
+ ), params.get('join'), params.get('count')
135
+ warning_wrong_parameters(self.probe_types_probes.__name__, params,
136
+ official_params_list)
115
137
  response = self.execute('GET', path=f'/probe_types/{uuid}/probes',
116
138
  single_page=single_page, page_size=page_size, warm_start=
117
139
  warm_start, params=params, **kwargs)
@@ -141,6 +163,10 @@ class ProbeTypes(ApiManager):
141
163
  Returns: list"""
142
164
  if kwargs is None:
143
165
  kwargs = dict()
166
+ official_params_list = ['join']
167
+ params.get('join')
168
+ warning_wrong_parameters(self.probe_types_bulk.__name__, params,
169
+ official_params_list)
144
170
  response = self.execute('POST', path=f'/probe_types/bulk/read/',
145
171
  single_page=single_page, page_size=page_size, warm_start=
146
172
  warm_start, params=params, payload=payload, **kwargs)
@@ -172,6 +198,10 @@ class ProbeTypes(ApiManager):
172
198
  Returns: list"""
173
199
  if kwargs is None:
174
200
  kwargs = dict()
201
+ official_params_list = ['best_effort']
202
+ params.get('best_effort')
203
+ warning_wrong_parameters(self.probe_types_create_bulk.__name__,
204
+ params, official_params_list)
175
205
  response = self.execute('POST', path=f'/probe_types/bulk/create/',
176
206
  single_page=single_page, page_size=page_size, params=params,
177
207
  payload=payload, **kwargs)
hive/cookbook/probes.py CHANGED
@@ -1,4 +1,4 @@
1
- from hive.api import ApiManager, handling_single_page_methods
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
2
 
3
3
 
4
4
  class Probes(ApiManager):
@@ -32,6 +32,18 @@ class Probes(ApiManager):
32
32
  Returns: list"""
33
33
  if kwargs is None:
34
34
  kwargs = dict()
35
+ official_params_list = ['sort_by', 'null_fields',
36
+ 'uuid_virtual_domain', 'uuid_probe_type', 'uuid_host', 'name',
37
+ 'description', 'notes', 'status', 'extract_severity', 'skip',
38
+ 'limit', 'like', 'join', 'count']
39
+ params.get('sort_by'), params.get('null_fields'), params.get(
40
+ 'uuid_virtual_domain'), params.get('uuid_probe_type'), params.get(
41
+ 'uuid_host'), params.get('name'), params.get('description'
42
+ ), params.get('notes'), params.get('status'), params.get(
43
+ 'extract_severity'), params.get('skip'), params.get('limit'
44
+ ), params.get('like'), params.get('join'), params.get('count')
45
+ warning_wrong_parameters(self.probes.__name__, params,
46
+ official_params_list)
35
47
  response = self.execute('GET', path=f'/probes/', single_page=
36
48
  single_page, page_size=page_size, warm_start=warm_start, params
37
49
  =params, **kwargs)
@@ -54,6 +66,15 @@ class Probes(ApiManager):
54
66
  Returns: list"""
55
67
  if kwargs is None:
56
68
  kwargs = dict()
69
+ official_payload_list = ['uuid_virtual_domain', 'uuid_probe_type',
70
+ 'uuid_host', 'name', 'description', 'data_profile', 'notes',
71
+ 'status']
72
+ payload.get('uuid_virtual_domain'), payload.get('uuid_probe_type'
73
+ ), payload.get('uuid_host'), payload.get('name'), payload.get(
74
+ 'description'), payload.get('data_profile'), payload.get('notes'
75
+ ), payload.get('status')
76
+ warning_wrong_parameters(self.probes_create.__name__, payload,
77
+ official_payload_list)
57
78
  response = self.execute('POST', path=f'/probes/', payload=payload,
58
79
  **kwargs)
59
80
  return response
@@ -73,6 +94,10 @@ class Probes(ApiManager):
73
94
  kwargs = dict()
74
95
  kwargs, params = handling_single_page_methods(kwargs=kwargs, params
75
96
  =params)
97
+ official_params_list = ['join']
98
+ params.get('join')
99
+ warning_wrong_parameters(self.probe.__name__, params,
100
+ official_params_list)
76
101
  response = self.execute('GET', path=f'/probes/{uuid}', warm_start=
77
102
  warm_start, params=params, **kwargs)
78
103
  return response
@@ -96,6 +121,15 @@ class Probes(ApiManager):
96
121
  Returns: list"""
97
122
  if kwargs is None:
98
123
  kwargs = dict()
124
+ official_payload_list = ['uuid_virtual_domain', 'uuid_probe_type',
125
+ 'uuid_host', 'name', 'description', 'data_profile', 'notes',
126
+ 'status', 'last_seen']
127
+ payload.get('uuid_virtual_domain'), payload.get('uuid_probe_type'
128
+ ), payload.get('uuid_host'), payload.get('name'), payload.get(
129
+ 'description'), payload.get('data_profile'), payload.get('notes'
130
+ ), payload.get('status'), payload.get('last_seen')
131
+ warning_wrong_parameters(self.probes_put.__name__, payload,
132
+ official_payload_list)
99
133
  response = self.execute('PUT', path=f'/probes/{uuid}', payload=
100
134
  payload, **kwargs)
101
135
  return response
@@ -120,14 +154,25 @@ class Probes(ApiManager):
120
154
  **payload: additional parameters for the API.
121
155
  Keyword Args:
122
156
  phone (string optional): additional filter - payload
157
+ verified_email (boolean optional): additional filter - payload
158
+ profile (string optional): additional filter - payload
123
159
  password (string optional): additional filter - payload
124
160
  email (string optional): additional filter - payload
161
+ stage (string optional): additional filter - payload
125
162
  active (boolean optional): additional filter - payload
126
163
  acl (object optional): additional filter - payload
127
164
  uuid_acl_override (string optional): additional filter - payload
128
165
  Returns: list"""
129
166
  if kwargs is None:
130
167
  kwargs = dict()
168
+ official_payload_list = ['phone', 'verified_email', 'profile',
169
+ 'password', 'email', 'stage', 'active', 'acl', 'uuid_acl_override']
170
+ payload.get('phone'), payload.get('verified_email'), payload.get(
171
+ 'profile'), payload.get('password'), payload.get('email'
172
+ ), payload.get('stage'), payload.get('active'), payload.get('acl'
173
+ ), payload.get('uuid_acl_override')
174
+ warning_wrong_parameters(self.probes_agent_put.__name__, payload,
175
+ official_payload_list)
131
176
  response = self.execute('PUT', path=f'/probes/agent/{uuid}',
132
177
  payload=payload, **kwargs)
133
178
  return response
@@ -145,6 +190,7 @@ class Probes(ApiManager):
145
190
  **params: additional parameters for the API.
146
191
  Keyword Args:
147
192
  not_in (boolean optional): additional filter - parameter
193
+ name (string optional): additional filter - parameter
148
194
  skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
149
195
  limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
150
196
  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
@@ -153,6 +199,13 @@ class Probes(ApiManager):
153
199
  Returns: list"""
154
200
  if kwargs is None:
155
201
  kwargs = dict()
202
+ official_params_list = ['not_in', 'name', 'skip', 'limit', 'like',
203
+ 'join', 'count']
204
+ params.get('not_in'), params.get('name'), params.get('skip'
205
+ ), params.get('limit'), params.get('like'), params.get('join'
206
+ ), params.get('count')
207
+ warning_wrong_parameters(self.probes_objects.__name__, params,
208
+ official_params_list)
156
209
  response = self.execute('GET', path=f'/probes/{uuid}/objects',
157
210
  single_page=single_page, page_size=page_size, warm_start=
158
211
  warm_start, params=params, **kwargs)
@@ -210,6 +263,10 @@ class Probes(ApiManager):
210
263
  Returns: list"""
211
264
  if kwargs is None:
212
265
  kwargs = dict()
266
+ official_params_list = ['join']
267
+ params.get('join')
268
+ warning_wrong_parameters(self.probes_bulk.__name__, params,
269
+ official_params_list)
213
270
  response = self.execute('POST', path=f'/probes/bulk/read/',
214
271
  single_page=single_page, page_size=page_size, warm_start=
215
272
  warm_start, params=params, payload=payload, **kwargs)
@@ -245,6 +302,10 @@ class Probes(ApiManager):
245
302
  Returns: list"""
246
303
  if kwargs is None:
247
304
  kwargs = dict()
305
+ official_params_list = ['best_effort']
306
+ params.get('best_effort')
307
+ warning_wrong_parameters(self.probes_create_bulk.__name__, params,
308
+ official_params_list)
248
309
  response = self.execute('POST', path=f'/probes/bulk/create/',
249
310
  single_page=single_page, page_size=page_size, params=params,
250
311
  payload=payload, **kwargs)
@@ -298,6 +359,10 @@ class Probes(ApiManager):
298
359
  Returns: list"""
299
360
  if kwargs is None:
300
361
  kwargs = dict()
362
+ official_params_list = ['best_effort']
363
+ params.get('best_effort')
364
+ warning_wrong_parameters(self.probes_objects_create_bulk.__name__,
365
+ params, official_params_list)
301
366
  response = self.execute('POST', path=f'/probes/bulk/create/objects',
302
367
  single_page=single_page, page_size=page_size, params=params,
303
368
  payload=payload, **kwargs)
@@ -347,6 +412,10 @@ class Probes(ApiManager):
347
412
  Returns: list"""
348
413
  if kwargs is None:
349
414
  kwargs = dict()
415
+ official_params_list = ['skip', 'limit']
416
+ params.get('skip'), params.get('limit')
417
+ warning_wrong_parameters(self.probes_logs.__name__, params,
418
+ official_params_list)
350
419
  response = self.execute('GET', path=f'/probes/{uuid}/logs',
351
420
  single_page=single_page, page_size=page_size, warm_start=
352
421
  warm_start, params=params, **kwargs)
@@ -1,4 +1,4 @@
1
- from hive.api import ApiManager, handling_single_page_methods
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
2
 
3
3
 
4
4
  class ProbesLogIngest(ApiManager):
@@ -26,6 +26,10 @@ class ProbesLogIngest(ApiManager):
26
26
  Returns: list"""
27
27
  if kwargs is None:
28
28
  kwargs = dict()
29
+ official_params_list = ['uuid_probe']
30
+ params.get('uuid_probe')
31
+ warning_wrong_parameters(self.probes_log_ingest_create.__name__,
32
+ params, official_params_list)
29
33
  response = self.execute('POST', path=f'/probes_log_ingest/',
30
34
  single_page=single_page, page_size=page_size, params=params,
31
35
  payload=payload, **kwargs)
@@ -1,4 +1,4 @@
1
- from hive.api import ApiManager, handling_single_page_methods
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
2
 
3
3
 
4
4
  class ProfileTopics(ApiManager):
@@ -26,6 +26,13 @@ class ProfileTopics(ApiManager):
26
26
  Returns: list"""
27
27
  if kwargs is None:
28
28
  kwargs = dict()
29
+ official_params_list = ['sort_by', 'profile', 'topic', 'skip',
30
+ 'limit', 'like', 'join', 'count']
31
+ params.get('sort_by'), params.get('profile'), params.get('topic'
32
+ ), params.get('skip'), params.get('limit'), params.get('like'
33
+ ), params.get('join'), params.get('count')
34
+ warning_wrong_parameters(self.profile_topics.__name__, params,
35
+ official_params_list)
29
36
  response = self.execute('GET', path=f'/profile_topics/',
30
37
  single_page=single_page, page_size=page_size, warm_start=
31
38
  warm_start, params=params, **kwargs)
@@ -42,6 +49,10 @@ class ProfileTopics(ApiManager):
42
49
  Returns: list"""
43
50
  if kwargs is None:
44
51
  kwargs = dict()
52
+ official_payload_list = ['profile', 'topic']
53
+ payload.get('profile'), payload.get('topic')
54
+ warning_wrong_parameters(self.profile_topics_create.__name__,
55
+ payload, official_payload_list)
45
56
  response = self.execute('POST', path=f'/profile_topics/', payload=
46
57
  payload, **kwargs)
47
58
  return response
@@ -73,6 +84,10 @@ class ProfileTopics(ApiManager):
73
84
  Returns: list"""
74
85
  if kwargs is None:
75
86
  kwargs = dict()
87
+ official_payload_list = ['profile', 'topic']
88
+ payload.get('profile'), payload.get('topic')
89
+ warning_wrong_parameters(self.profile_topics_put.__name__, payload,
90
+ official_payload_list)
76
91
  response = self.execute('PUT', path=f'/profile_topics/{uuid}',
77
92
  payload=payload, **kwargs)
78
93
  return response
@@ -113,6 +128,10 @@ class ProfileTopics(ApiManager):
113
128
  Returns: list"""
114
129
  if kwargs is None:
115
130
  kwargs = dict()
131
+ official_params_list = ['join']
132
+ params.get('join')
133
+ warning_wrong_parameters(self.profile_topics_bulk.__name__, params,
134
+ official_params_list)
116
135
  response = self.execute('POST', path=f'/profile_topics/bulk/read/',
117
136
  single_page=single_page, page_size=page_size, warm_start=
118
137
  warm_start, params=params, payload=payload, **kwargs)
@@ -143,6 +162,10 @@ class ProfileTopics(ApiManager):
143
162
  Returns: list"""
144
163
  if kwargs is None:
145
164
  kwargs = dict()
165
+ official_params_list = ['best_effort']
166
+ params.get('best_effort')
167
+ warning_wrong_parameters(self.profile_topics_create_bulk.__name__,
168
+ params, official_params_list)
146
169
  response = self.execute('POST', path=
147
170
  f'/profile_topics/bulk/create/', single_page=single_page,
148
171
  page_size=page_size, params=params, payload=payload, **kwargs)