scc-firewall-manager-sdk 1.15.195__py3-none-any.whl → 1.15.563__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 (58) hide show
  1. scc_firewall_manager_sdk/__init__.py +19 -2
  2. scc_firewall_manager_sdk/api/__init__.py +2 -0
  3. scc_firewall_manager_sdk/api/ai_assistant_api.py +12 -12
  4. scc_firewall_manager_sdk/api/asa_access_groups_api.py +12 -12
  5. scc_firewall_manager_sdk/api/asa_access_rules_api.py +12 -12
  6. scc_firewall_manager_sdk/api/asa_interfaces_api.py +72 -72
  7. scc_firewall_manager_sdk/api/audit_logs_api.py +12 -12
  8. scc_firewall_manager_sdk/api/change_requests_api.py +12 -12
  9. scc_firewall_manager_sdk/api/changelogs_api.py +12 -12
  10. scc_firewall_manager_sdk/api/command_line_interface_api.py +24 -24
  11. scc_firewall_manager_sdk/api/connectors_api.py +12 -12
  12. scc_firewall_manager_sdk/api/device_health_aggregations_api.py +19 -19
  13. scc_firewall_manager_sdk/api/device_upgrades_api.py +298 -297
  14. scc_firewall_manager_sdk/api/events_api.py +358 -0
  15. scc_firewall_manager_sdk/api/interface_health_aggregations_api.py +344 -0
  16. scc_firewall_manager_sdk/api/inventory_api.py +48 -48
  17. scc_firewall_manager_sdk/api/licensing_api.py +626 -0
  18. scc_firewall_manager_sdk/api/msp_device_upgrades_api.py +1692 -37
  19. scc_firewall_manager_sdk/api/msp_inventory_api.py +48 -48
  20. scc_firewall_manager_sdk/api/msp_tenant_management_api.py +41 -12
  21. scc_firewall_manager_sdk/api/msp_user_management_api.py +24 -24
  22. scc_firewall_manager_sdk/api/object_management_api.py +17 -0
  23. scc_firewall_manager_sdk/api/remote_access_monitoring_api.py +24 -24
  24. scc_firewall_manager_sdk/api/tenant_management_api.py +21 -18
  25. scc_firewall_manager_sdk/api/users_api.py +30 -30
  26. scc_firewall_manager_sdk/api_client.py +1 -1
  27. scc_firewall_manager_sdk/configuration.py +1 -1
  28. scc_firewall_manager_sdk/models/__init__.py +16 -1
  29. scc_firewall_manager_sdk/models/access_group.py +1 -1
  30. scc_firewall_manager_sdk/models/cdo_token_info.py +3 -1
  31. scc_firewall_manager_sdk/models/cdo_transaction.py +14 -14
  32. scc_firewall_manager_sdk/models/common_api_error.py +3 -3
  33. scc_firewall_manager_sdk/models/compatible_device_dto.py +100 -0
  34. scc_firewall_manager_sdk/models/compatible_version_info_dto.py +112 -0
  35. scc_firewall_manager_sdk/models/completion_status_dto.py +104 -0
  36. scc_firewall_manager_sdk/models/device_license_dto.py +133 -0
  37. scc_firewall_manager_sdk/models/device_license_page.py +102 -0
  38. scc_firewall_manager_sdk/models/{tenant_ftd_compatibility_version.py → device_upgrade_status_dto.py} +14 -18
  39. scc_firewall_manager_sdk/models/enable_cd_fmc_for_tenant_request.py +88 -0
  40. scc_firewall_manager_sdk/models/log_settings.py +1 -1
  41. scc_firewall_manager_sdk/models/metric_aggregation_list_item.py +12 -8
  42. scc_firewall_manager_sdk/models/msp_calculate_compatible_upgrade_versions_input.py +89 -0
  43. scc_firewall_manager_sdk/models/msp_managed_device.py +13 -1
  44. scc_firewall_manager_sdk/models/msp_managed_device_distinct_attribute_values.py +5 -1
  45. scc_firewall_manager_sdk/models/msp_upgrade_ftd_devices_input.py +97 -0
  46. scc_firewall_manager_sdk/models/msp_upgrade_run_dto.py +135 -0
  47. scc_firewall_manager_sdk/models/msp_upgrade_run_dto_page.py +102 -0
  48. scc_firewall_manager_sdk/models/msp_upgrade_runs_attribute_values.py +114 -0
  49. scc_firewall_manager_sdk/models/page.py +94 -0
  50. scc_firewall_manager_sdk/models/smart_account.py +90 -0
  51. scc_firewall_manager_sdk/models/tenant_settings.py +3 -1
  52. scc_firewall_manager_sdk/models/upgrade_compatibility_info_dto.py +107 -0
  53. scc_firewall_manager_sdk/models/upgrade_run_dto.py +14 -4
  54. scc_firewall_manager_sdk/models/upgrade_run_metadata_dto.py +96 -0
  55. {scc_firewall_manager_sdk-1.15.195.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/METADATA +1 -1
  56. {scc_firewall_manager_sdk-1.15.195.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/RECORD +58 -41
  57. {scc_firewall_manager_sdk-1.15.195.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/WHEEL +0 -0
  58. {scc_firewall_manager_sdk-1.15.195.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/top_level.txt +0 -0
@@ -18,9 +18,15 @@ from typing import Any, Dict, List, Optional, Tuple, Union
18
18
  from typing_extensions import Annotated
19
19
 
20
20
  from pydantic import Field, StrictStr
21
- from typing import List
21
+ from typing import List, Optional
22
22
  from typing_extensions import Annotated
23
- from scc_firewall_manager_sdk.models.tenant_ftd_compatibility_version import TenantFtdCompatibilityVersion
23
+ from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
24
+ from scc_firewall_manager_sdk.models.msp_calculate_compatible_upgrade_versions_input import MspCalculateCompatibleUpgradeVersionsInput
25
+ from scc_firewall_manager_sdk.models.msp_upgrade_ftd_devices_input import MspUpgradeFtdDevicesInput
26
+ from scc_firewall_manager_sdk.models.msp_upgrade_run_dto import MspUpgradeRunDto
27
+ from scc_firewall_manager_sdk.models.msp_upgrade_run_dto_page import MspUpgradeRunDtoPage
28
+ from scc_firewall_manager_sdk.models.msp_upgrade_runs_attribute_values import MspUpgradeRunsAttributeValues
29
+ from scc_firewall_manager_sdk.models.upgrade_compatibility_info_dto import UpgradeCompatibilityInfoDto
24
30
 
25
31
  from scc_firewall_manager_sdk.api_client import ApiClient, RequestSerialized
26
32
  from scc_firewall_manager_sdk.api_response import ApiResponse
@@ -41,9 +47,9 @@ class MSPDeviceUpgradesApi:
41
47
 
42
48
 
43
49
  @validate_call
44
- def get_compatible_ftd_versions_for_msp_managed_ftd_devices(
50
+ def calculate_msp_ftd_compatible_upgrade_versions(
45
51
  self,
46
- device_uids: Annotated[List[StrictStr], Field(min_length=1, max_length=50, description="A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All of the devices specified have to be on tenants managed by the MSP portal.")],
52
+ msp_calculate_compatible_upgrade_versions_input: MspCalculateCompatibleUpgradeVersionsInput,
47
53
  _request_timeout: Union[
48
54
  None,
49
55
  Annotated[StrictFloat, Field(gt=0)],
@@ -56,13 +62,13 @@ class MSPDeviceUpgradesApi:
56
62
  _content_type: Optional[StrictStr] = None,
57
63
  _headers: Optional[Dict[StrictStr, Any]] = None,
58
64
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
59
- ) -> TenantFtdCompatibilityVersion:
60
- """Get upgrade versions compatible with multiple FTDs per tenant
65
+ ) -> CdoTransaction:
66
+ """Calculate compatible FTD upgrade versions
61
67
 
62
- <p>List of compatible upgrade versions, grouped by tenant and hardware model.</p> <p><strong>First Request:</strong></p> <ul> <li>When called with a list of device UUIDs for the first time</li> <li>Returns <strong>HTTP 202</strong> (Accepted) with a transaction ID</li> <li>Asynchronously builds the list of compatible upgrade versions in the background</li> </ul> <p><strong>Subsequent Requests:</strong></p> <ul> <li>When called again after the transaction completes</li> <li>Returns <strong>HTTP 200</strong> (OK) with the actual compatible upgrade versions data, grouped by the unique identifiers of the managed tenant and the hardware model of the device. </li> </ul> <p><strong>Usage Pattern:</strong></p> <ol> <li>Make initial request with device UUIDs</li> <li>Receive 202 response with transaction details</li> <li>Poll the endpoint until you receive a 200 response with the results</li> </ol> <p><em>Note:</em> The response will be grouped by tenant for easier organization and processing.</p> <p><em>Note:</em> The response will return a single compatible version, if available, for all of the devices in a single tenant..</p>
68
+ An asynchronous operation to calculate a list of compatible upgrade versions for a list of CdFMC-managed FTD devices across multiple managed tenants.
63
69
 
64
- :param device_uids: A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All of the devices specified have to be on tenants managed by the MSP portal. (required)
65
- :type device_uids: List[str]
70
+ :param msp_calculate_compatible_upgrade_versions_input: (required)
71
+ :type msp_calculate_compatible_upgrade_versions_input: MspCalculateCompatibleUpgradeVersionsInput
66
72
  :param _request_timeout: timeout setting for this request. If one
67
73
  number provided, it will be total request
68
74
  timeout. It can also be a pair (tuple) of
@@ -85,8 +91,8 @@ class MSPDeviceUpgradesApi:
85
91
  :return: Returns the result object.
86
92
  """ # noqa: E501
87
93
 
88
- _param = self._get_compatible_ftd_versions_for_msp_managed_ftd_devices_serialize(
89
- device_uids=device_uids,
94
+ _param = self._calculate_msp_ftd_compatible_upgrade_versions_serialize(
95
+ msp_calculate_compatible_upgrade_versions_input=msp_calculate_compatible_upgrade_versions_input,
90
96
  _request_auth=_request_auth,
91
97
  _content_type=_content_type,
92
98
  _headers=_headers,
@@ -94,8 +100,10 @@ class MSPDeviceUpgradesApi:
94
100
  )
95
101
 
96
102
  _response_types_map: Dict[str, Optional[str]] = {
97
- '200': "TenantFtdCompatibilityVersion",
98
103
  '202': "CdoTransaction",
104
+ '400': "CommonApiError",
105
+ '401': "AuthenticationError",
106
+ '403': "CommonApiError",
99
107
  '404': "CommonApiError",
100
108
  '422': "CommonApiError",
101
109
  '500': "CommonApiError",
@@ -112,9 +120,9 @@ class MSPDeviceUpgradesApi:
112
120
 
113
121
 
114
122
  @validate_call
115
- def get_compatible_ftd_versions_for_msp_managed_ftd_devices_with_http_info(
123
+ def calculate_msp_ftd_compatible_upgrade_versions_with_http_info(
116
124
  self,
117
- device_uids: Annotated[List[StrictStr], Field(min_length=1, max_length=50, description="A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All of the devices specified have to be on tenants managed by the MSP portal.")],
125
+ msp_calculate_compatible_upgrade_versions_input: MspCalculateCompatibleUpgradeVersionsInput,
118
126
  _request_timeout: Union[
119
127
  None,
120
128
  Annotated[StrictFloat, Field(gt=0)],
@@ -127,13 +135,13 @@ class MSPDeviceUpgradesApi:
127
135
  _content_type: Optional[StrictStr] = None,
128
136
  _headers: Optional[Dict[StrictStr, Any]] = None,
129
137
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
130
- ) -> ApiResponse[TenantFtdCompatibilityVersion]:
131
- """Get upgrade versions compatible with multiple FTDs per tenant
138
+ ) -> ApiResponse[CdoTransaction]:
139
+ """Calculate compatible FTD upgrade versions
132
140
 
133
- <p>List of compatible upgrade versions, grouped by tenant and hardware model.</p> <p><strong>First Request:</strong></p> <ul> <li>When called with a list of device UUIDs for the first time</li> <li>Returns <strong>HTTP 202</strong> (Accepted) with a transaction ID</li> <li>Asynchronously builds the list of compatible upgrade versions in the background</li> </ul> <p><strong>Subsequent Requests:</strong></p> <ul> <li>When called again after the transaction completes</li> <li>Returns <strong>HTTP 200</strong> (OK) with the actual compatible upgrade versions data, grouped by the unique identifiers of the managed tenant and the hardware model of the device. </li> </ul> <p><strong>Usage Pattern:</strong></p> <ol> <li>Make initial request with device UUIDs</li> <li>Receive 202 response with transaction details</li> <li>Poll the endpoint until you receive a 200 response with the results</li> </ol> <p><em>Note:</em> The response will be grouped by tenant for easier organization and processing.</p> <p><em>Note:</em> The response will return a single compatible version, if available, for all of the devices in a single tenant..</p>
141
+ An asynchronous operation to calculate a list of compatible upgrade versions for a list of CdFMC-managed FTD devices across multiple managed tenants.
134
142
 
135
- :param device_uids: A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All of the devices specified have to be on tenants managed by the MSP portal. (required)
136
- :type device_uids: List[str]
143
+ :param msp_calculate_compatible_upgrade_versions_input: (required)
144
+ :type msp_calculate_compatible_upgrade_versions_input: MspCalculateCompatibleUpgradeVersionsInput
137
145
  :param _request_timeout: timeout setting for this request. If one
138
146
  number provided, it will be total request
139
147
  timeout. It can also be a pair (tuple) of
@@ -156,8 +164,8 @@ class MSPDeviceUpgradesApi:
156
164
  :return: Returns the result object.
157
165
  """ # noqa: E501
158
166
 
159
- _param = self._get_compatible_ftd_versions_for_msp_managed_ftd_devices_serialize(
160
- device_uids=device_uids,
167
+ _param = self._calculate_msp_ftd_compatible_upgrade_versions_serialize(
168
+ msp_calculate_compatible_upgrade_versions_input=msp_calculate_compatible_upgrade_versions_input,
161
169
  _request_auth=_request_auth,
162
170
  _content_type=_content_type,
163
171
  _headers=_headers,
@@ -165,8 +173,10 @@ class MSPDeviceUpgradesApi:
165
173
  )
166
174
 
167
175
  _response_types_map: Dict[str, Optional[str]] = {
168
- '200': "TenantFtdCompatibilityVersion",
169
176
  '202': "CdoTransaction",
177
+ '400': "CommonApiError",
178
+ '401': "AuthenticationError",
179
+ '403': "CommonApiError",
170
180
  '404': "CommonApiError",
171
181
  '422': "CommonApiError",
172
182
  '500': "CommonApiError",
@@ -183,9 +193,9 @@ class MSPDeviceUpgradesApi:
183
193
 
184
194
 
185
195
  @validate_call
186
- def get_compatible_ftd_versions_for_msp_managed_ftd_devices_without_preload_content(
196
+ def calculate_msp_ftd_compatible_upgrade_versions_without_preload_content(
187
197
  self,
188
- device_uids: Annotated[List[StrictStr], Field(min_length=1, max_length=50, description="A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All of the devices specified have to be on tenants managed by the MSP portal.")],
198
+ msp_calculate_compatible_upgrade_versions_input: MspCalculateCompatibleUpgradeVersionsInput,
189
199
  _request_timeout: Union[
190
200
  None,
191
201
  Annotated[StrictFloat, Field(gt=0)],
@@ -199,12 +209,12 @@ class MSPDeviceUpgradesApi:
199
209
  _headers: Optional[Dict[StrictStr, Any]] = None,
200
210
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
201
211
  ) -> RESTResponseType:
202
- """Get upgrade versions compatible with multiple FTDs per tenant
212
+ """Calculate compatible FTD upgrade versions
203
213
 
204
- <p>List of compatible upgrade versions, grouped by tenant and hardware model.</p> <p><strong>First Request:</strong></p> <ul> <li>When called with a list of device UUIDs for the first time</li> <li>Returns <strong>HTTP 202</strong> (Accepted) with a transaction ID</li> <li>Asynchronously builds the list of compatible upgrade versions in the background</li> </ul> <p><strong>Subsequent Requests:</strong></p> <ul> <li>When called again after the transaction completes</li> <li>Returns <strong>HTTP 200</strong> (OK) with the actual compatible upgrade versions data, grouped by the unique identifiers of the managed tenant and the hardware model of the device. </li> </ul> <p><strong>Usage Pattern:</strong></p> <ol> <li>Make initial request with device UUIDs</li> <li>Receive 202 response with transaction details</li> <li>Poll the endpoint until you receive a 200 response with the results</li> </ol> <p><em>Note:</em> The response will be grouped by tenant for easier organization and processing.</p> <p><em>Note:</em> The response will return a single compatible version, if available, for all of the devices in a single tenant..</p>
214
+ An asynchronous operation to calculate a list of compatible upgrade versions for a list of CdFMC-managed FTD devices across multiple managed tenants.
205
215
 
206
- :param device_uids: A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All of the devices specified have to be on tenants managed by the MSP portal. (required)
207
- :type device_uids: List[str]
216
+ :param msp_calculate_compatible_upgrade_versions_input: (required)
217
+ :type msp_calculate_compatible_upgrade_versions_input: MspCalculateCompatibleUpgradeVersionsInput
208
218
  :param _request_timeout: timeout setting for this request. If one
209
219
  number provided, it will be total request
210
220
  timeout. It can also be a pair (tuple) of
@@ -227,8 +237,8 @@ class MSPDeviceUpgradesApi:
227
237
  :return: Returns the result object.
228
238
  """ # noqa: E501
229
239
 
230
- _param = self._get_compatible_ftd_versions_for_msp_managed_ftd_devices_serialize(
231
- device_uids=device_uids,
240
+ _param = self._calculate_msp_ftd_compatible_upgrade_versions_serialize(
241
+ msp_calculate_compatible_upgrade_versions_input=msp_calculate_compatible_upgrade_versions_input,
232
242
  _request_auth=_request_auth,
233
243
  _content_type=_content_type,
234
244
  _headers=_headers,
@@ -236,8 +246,10 @@ class MSPDeviceUpgradesApi:
236
246
  )
237
247
 
238
248
  _response_types_map: Dict[str, Optional[str]] = {
239
- '200': "TenantFtdCompatibilityVersion",
240
249
  '202': "CdoTransaction",
250
+ '400': "CommonApiError",
251
+ '401': "AuthenticationError",
252
+ '403': "CommonApiError",
241
253
  '404': "CommonApiError",
242
254
  '422': "CommonApiError",
243
255
  '500': "CommonApiError",
@@ -249,9 +261,9 @@ class MSPDeviceUpgradesApi:
249
261
  return response_data.response
250
262
 
251
263
 
252
- def _get_compatible_ftd_versions_for_msp_managed_ftd_devices_serialize(
264
+ def _calculate_msp_ftd_compatible_upgrade_versions_serialize(
253
265
  self,
254
- device_uids,
266
+ msp_calculate_compatible_upgrade_versions_input,
255
267
  _request_auth,
256
268
  _content_type,
257
269
  _headers,
@@ -261,7 +273,6 @@ class MSPDeviceUpgradesApi:
261
273
  _host = None
262
274
 
263
275
  _collection_formats: Dict[str, str] = {
264
- 'deviceUids': 'multi',
265
276
  }
266
277
 
267
278
  _path_params: Dict[str, str] = {}
@@ -273,10 +284,1380 @@ class MSPDeviceUpgradesApi:
273
284
 
274
285
  # process the path parameters
275
286
  # process the query parameters
276
- if device_uids is not None:
287
+ # process the header parameters
288
+ # process the form parameters
289
+ # process the body parameter
290
+ if msp_calculate_compatible_upgrade_versions_input is not None:
291
+ _body_params = msp_calculate_compatible_upgrade_versions_input
292
+
293
+
294
+ # set the HTTP header `Accept`
295
+ _header_params['Accept'] = self.api_client.select_header_accept(
296
+ [
297
+ 'application/json'
298
+ ]
299
+ )
300
+
301
+ # set the HTTP header `Content-Type`
302
+ if _content_type:
303
+ _header_params['Content-Type'] = _content_type
304
+ else:
305
+ _default_content_type = (
306
+ self.api_client.select_header_content_type(
307
+ [
308
+ 'application/json'
309
+ ]
310
+ )
311
+ )
312
+ if _default_content_type is not None:
313
+ _header_params['Content-Type'] = _default_content_type
314
+
315
+ # authentication setting
316
+ _auth_settings: List[str] = [
317
+ 'bearerAuth'
318
+ ]
319
+
320
+ return self.api_client.param_serialize(
321
+ method='POST',
322
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/versions',
323
+ path_params=_path_params,
324
+ query_params=_query_params,
325
+ header_params=_header_params,
326
+ body=_body_params,
327
+ post_params=_form_params,
328
+ files=_files,
329
+ auth_settings=_auth_settings,
330
+ collection_formats=_collection_formats,
331
+ _host=_host,
332
+ _request_auth=_request_auth
333
+ )
334
+
335
+
336
+
337
+
338
+ @validate_call
339
+ def delete_msp_device_upgrade_run(
340
+ self,
341
+ uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
342
+ _request_timeout: Union[
343
+ None,
344
+ Annotated[StrictFloat, Field(gt=0)],
345
+ Tuple[
346
+ Annotated[StrictFloat, Field(gt=0)],
347
+ Annotated[StrictFloat, Field(gt=0)]
348
+ ]
349
+ ] = None,
350
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
351
+ _content_type: Optional[StrictStr] = None,
352
+ _headers: Optional[Dict[StrictStr, Any]] = None,
353
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
354
+ ) -> None:
355
+ """Delete MSP Device Upgrade Run
356
+
357
+ Delete a MSP Device Upgrade Run, by UID, in the SCC Firewall Manager tenant. Caution: If you delete an upgrade run currently in progress, you may end up allowing multiple upgrades to be triggered on devices.
358
+
359
+ :param uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
360
+ :type uid: str
361
+ :param _request_timeout: timeout setting for this request. If one
362
+ number provided, it will be total request
363
+ timeout. It can also be a pair (tuple) of
364
+ (connection, read) timeouts.
365
+ :type _request_timeout: int, tuple(int, int), optional
366
+ :param _request_auth: set to override the auth_settings for an a single
367
+ request; this effectively ignores the
368
+ authentication in the spec for a single request.
369
+ :type _request_auth: dict, optional
370
+ :param _content_type: force content-type for the request.
371
+ :type _content_type: str, Optional
372
+ :param _headers: set to override the headers for a single
373
+ request; this effectively ignores the headers
374
+ in the spec for a single request.
375
+ :type _headers: dict, optional
376
+ :param _host_index: set to override the host_index for a single
377
+ request; this effectively ignores the host_index
378
+ in the spec for a single request.
379
+ :type _host_index: int, optional
380
+ :return: Returns the result object.
381
+ """ # noqa: E501
382
+
383
+ _param = self._delete_msp_device_upgrade_run_serialize(
384
+ uid=uid,
385
+ _request_auth=_request_auth,
386
+ _content_type=_content_type,
387
+ _headers=_headers,
388
+ _host_index=_host_index
389
+ )
390
+
391
+ _response_types_map: Dict[str, Optional[str]] = {
392
+ '204': None,
393
+ '500': "CommonApiError",
394
+ }
395
+ response_data = self.api_client.call_api(
396
+ *_param,
397
+ _request_timeout=_request_timeout
398
+ )
399
+ response_data.read()
400
+ return self.api_client.response_deserialize(
401
+ response_data=response_data,
402
+ response_types_map=_response_types_map,
403
+ ).data
404
+
405
+
406
+ @validate_call
407
+ def delete_msp_device_upgrade_run_with_http_info(
408
+ self,
409
+ uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
410
+ _request_timeout: Union[
411
+ None,
412
+ Annotated[StrictFloat, Field(gt=0)],
413
+ Tuple[
414
+ Annotated[StrictFloat, Field(gt=0)],
415
+ Annotated[StrictFloat, Field(gt=0)]
416
+ ]
417
+ ] = None,
418
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
419
+ _content_type: Optional[StrictStr] = None,
420
+ _headers: Optional[Dict[StrictStr, Any]] = None,
421
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
422
+ ) -> ApiResponse[None]:
423
+ """Delete MSP Device Upgrade Run
424
+
425
+ Delete a MSP Device Upgrade Run, by UID, in the SCC Firewall Manager tenant. Caution: If you delete an upgrade run currently in progress, you may end up allowing multiple upgrades to be triggered on devices.
426
+
427
+ :param uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
428
+ :type uid: str
429
+ :param _request_timeout: timeout setting for this request. If one
430
+ number provided, it will be total request
431
+ timeout. It can also be a pair (tuple) of
432
+ (connection, read) timeouts.
433
+ :type _request_timeout: int, tuple(int, int), optional
434
+ :param _request_auth: set to override the auth_settings for an a single
435
+ request; this effectively ignores the
436
+ authentication in the spec for a single request.
437
+ :type _request_auth: dict, optional
438
+ :param _content_type: force content-type for the request.
439
+ :type _content_type: str, Optional
440
+ :param _headers: set to override the headers for a single
441
+ request; this effectively ignores the headers
442
+ in the spec for a single request.
443
+ :type _headers: dict, optional
444
+ :param _host_index: set to override the host_index for a single
445
+ request; this effectively ignores the host_index
446
+ in the spec for a single request.
447
+ :type _host_index: int, optional
448
+ :return: Returns the result object.
449
+ """ # noqa: E501
450
+
451
+ _param = self._delete_msp_device_upgrade_run_serialize(
452
+ uid=uid,
453
+ _request_auth=_request_auth,
454
+ _content_type=_content_type,
455
+ _headers=_headers,
456
+ _host_index=_host_index
457
+ )
458
+
459
+ _response_types_map: Dict[str, Optional[str]] = {
460
+ '204': None,
461
+ '500': "CommonApiError",
462
+ }
463
+ response_data = self.api_client.call_api(
464
+ *_param,
465
+ _request_timeout=_request_timeout
466
+ )
467
+ response_data.read()
468
+ return self.api_client.response_deserialize(
469
+ response_data=response_data,
470
+ response_types_map=_response_types_map,
471
+ )
472
+
473
+
474
+ @validate_call
475
+ def delete_msp_device_upgrade_run_without_preload_content(
476
+ self,
477
+ uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
478
+ _request_timeout: Union[
479
+ None,
480
+ Annotated[StrictFloat, Field(gt=0)],
481
+ Tuple[
482
+ Annotated[StrictFloat, Field(gt=0)],
483
+ Annotated[StrictFloat, Field(gt=0)]
484
+ ]
485
+ ] = None,
486
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
487
+ _content_type: Optional[StrictStr] = None,
488
+ _headers: Optional[Dict[StrictStr, Any]] = None,
489
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
490
+ ) -> RESTResponseType:
491
+ """Delete MSP Device Upgrade Run
492
+
493
+ Delete a MSP Device Upgrade Run, by UID, in the SCC Firewall Manager tenant. Caution: If you delete an upgrade run currently in progress, you may end up allowing multiple upgrades to be triggered on devices.
494
+
495
+ :param uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
496
+ :type uid: str
497
+ :param _request_timeout: timeout setting for this request. If one
498
+ number provided, it will be total request
499
+ timeout. It can also be a pair (tuple) of
500
+ (connection, read) timeouts.
501
+ :type _request_timeout: int, tuple(int, int), optional
502
+ :param _request_auth: set to override the auth_settings for an a single
503
+ request; this effectively ignores the
504
+ authentication in the spec for a single request.
505
+ :type _request_auth: dict, optional
506
+ :param _content_type: force content-type for the request.
507
+ :type _content_type: str, Optional
508
+ :param _headers: set to override the headers for a single
509
+ request; this effectively ignores the headers
510
+ in the spec for a single request.
511
+ :type _headers: dict, optional
512
+ :param _host_index: set to override the host_index for a single
513
+ request; this effectively ignores the host_index
514
+ in the spec for a single request.
515
+ :type _host_index: int, optional
516
+ :return: Returns the result object.
517
+ """ # noqa: E501
518
+
519
+ _param = self._delete_msp_device_upgrade_run_serialize(
520
+ uid=uid,
521
+ _request_auth=_request_auth,
522
+ _content_type=_content_type,
523
+ _headers=_headers,
524
+ _host_index=_host_index
525
+ )
526
+
527
+ _response_types_map: Dict[str, Optional[str]] = {
528
+ '204': None,
529
+ '500': "CommonApiError",
530
+ }
531
+ response_data = self.api_client.call_api(
532
+ *_param,
533
+ _request_timeout=_request_timeout
534
+ )
535
+ return response_data.response
536
+
537
+
538
+ def _delete_msp_device_upgrade_run_serialize(
539
+ self,
540
+ uid,
541
+ _request_auth,
542
+ _content_type,
543
+ _headers,
544
+ _host_index,
545
+ ) -> RequestSerialized:
546
+
547
+ _host = None
548
+
549
+ _collection_formats: Dict[str, str] = {
550
+ }
551
+
552
+ _path_params: Dict[str, str] = {}
553
+ _query_params: List[Tuple[str, str]] = []
554
+ _header_params: Dict[str, Optional[str]] = _headers or {}
555
+ _form_params: List[Tuple[str, str]] = []
556
+ _files: Dict[str, str] = {}
557
+ _body_params: Optional[bytes] = None
558
+
559
+ # process the path parameters
560
+ if uid is not None:
561
+ _path_params['uid'] = uid
562
+ # process the query parameters
563
+ # process the header parameters
564
+ # process the form parameters
565
+ # process the body parameter
566
+
567
+
568
+ # set the HTTP header `Accept`
569
+ _header_params['Accept'] = self.api_client.select_header_accept(
570
+ [
571
+ 'application/json'
572
+ ]
573
+ )
574
+
575
+
576
+ # authentication setting
577
+ _auth_settings: List[str] = [
578
+ 'bearerAuth'
579
+ ]
580
+
581
+ return self.api_client.param_serialize(
582
+ method='DELETE',
583
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs/{uid}',
584
+ path_params=_path_params,
585
+ query_params=_query_params,
586
+ header_params=_header_params,
587
+ body=_body_params,
588
+ post_params=_form_params,
589
+ files=_files,
590
+ auth_settings=_auth_settings,
591
+ collection_formats=_collection_formats,
592
+ _host=_host,
593
+ _request_auth=_request_auth
594
+ )
595
+
596
+
597
+
598
+
599
+ @validate_call
600
+ def get_msp_device_upgrade_run(
601
+ self,
602
+ msp_upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
603
+ _request_timeout: Union[
604
+ None,
605
+ Annotated[StrictFloat, Field(gt=0)],
606
+ Tuple[
607
+ Annotated[StrictFloat, Field(gt=0)],
608
+ Annotated[StrictFloat, Field(gt=0)]
609
+ ]
610
+ ] = None,
611
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
612
+ _content_type: Optional[StrictStr] = None,
613
+ _headers: Optional[Dict[StrictStr, Any]] = None,
614
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
615
+ ) -> MspUpgradeRunDto:
616
+ """Get MSP Device Upgrade Run
617
+
618
+ Get a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
619
+
620
+ :param msp_upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
621
+ :type msp_upgrade_run_uid: str
622
+ :param _request_timeout: timeout setting for this request. If one
623
+ number provided, it will be total request
624
+ timeout. It can also be a pair (tuple) of
625
+ (connection, read) timeouts.
626
+ :type _request_timeout: int, tuple(int, int), optional
627
+ :param _request_auth: set to override the auth_settings for an a single
628
+ request; this effectively ignores the
629
+ authentication in the spec for a single request.
630
+ :type _request_auth: dict, optional
631
+ :param _content_type: force content-type for the request.
632
+ :type _content_type: str, Optional
633
+ :param _headers: set to override the headers for a single
634
+ request; this effectively ignores the headers
635
+ in the spec for a single request.
636
+ :type _headers: dict, optional
637
+ :param _host_index: set to override the host_index for a single
638
+ request; this effectively ignores the host_index
639
+ in the spec for a single request.
640
+ :type _host_index: int, optional
641
+ :return: Returns the result object.
642
+ """ # noqa: E501
643
+
644
+ _param = self._get_msp_device_upgrade_run_serialize(
645
+ msp_upgrade_run_uid=msp_upgrade_run_uid,
646
+ _request_auth=_request_auth,
647
+ _content_type=_content_type,
648
+ _headers=_headers,
649
+ _host_index=_host_index
650
+ )
651
+
652
+ _response_types_map: Dict[str, Optional[str]] = {
653
+ '200': "MspUpgradeRunDto",
654
+ '404': "CommonApiError",
655
+ '500': "CommonApiError",
656
+ }
657
+ response_data = self.api_client.call_api(
658
+ *_param,
659
+ _request_timeout=_request_timeout
660
+ )
661
+ response_data.read()
662
+ return self.api_client.response_deserialize(
663
+ response_data=response_data,
664
+ response_types_map=_response_types_map,
665
+ ).data
666
+
667
+
668
+ @validate_call
669
+ def get_msp_device_upgrade_run_with_http_info(
670
+ self,
671
+ msp_upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
672
+ _request_timeout: Union[
673
+ None,
674
+ Annotated[StrictFloat, Field(gt=0)],
675
+ Tuple[
676
+ Annotated[StrictFloat, Field(gt=0)],
677
+ Annotated[StrictFloat, Field(gt=0)]
678
+ ]
679
+ ] = None,
680
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
681
+ _content_type: Optional[StrictStr] = None,
682
+ _headers: Optional[Dict[StrictStr, Any]] = None,
683
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
684
+ ) -> ApiResponse[MspUpgradeRunDto]:
685
+ """Get MSP Device Upgrade Run
686
+
687
+ Get a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
688
+
689
+ :param msp_upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
690
+ :type msp_upgrade_run_uid: str
691
+ :param _request_timeout: timeout setting for this request. If one
692
+ number provided, it will be total request
693
+ timeout. It can also be a pair (tuple) of
694
+ (connection, read) timeouts.
695
+ :type _request_timeout: int, tuple(int, int), optional
696
+ :param _request_auth: set to override the auth_settings for an a single
697
+ request; this effectively ignores the
698
+ authentication in the spec for a single request.
699
+ :type _request_auth: dict, optional
700
+ :param _content_type: force content-type for the request.
701
+ :type _content_type: str, Optional
702
+ :param _headers: set to override the headers for a single
703
+ request; this effectively ignores the headers
704
+ in the spec for a single request.
705
+ :type _headers: dict, optional
706
+ :param _host_index: set to override the host_index for a single
707
+ request; this effectively ignores the host_index
708
+ in the spec for a single request.
709
+ :type _host_index: int, optional
710
+ :return: Returns the result object.
711
+ """ # noqa: E501
712
+
713
+ _param = self._get_msp_device_upgrade_run_serialize(
714
+ msp_upgrade_run_uid=msp_upgrade_run_uid,
715
+ _request_auth=_request_auth,
716
+ _content_type=_content_type,
717
+ _headers=_headers,
718
+ _host_index=_host_index
719
+ )
720
+
721
+ _response_types_map: Dict[str, Optional[str]] = {
722
+ '200': "MspUpgradeRunDto",
723
+ '404': "CommonApiError",
724
+ '500': "CommonApiError",
725
+ }
726
+ response_data = self.api_client.call_api(
727
+ *_param,
728
+ _request_timeout=_request_timeout
729
+ )
730
+ response_data.read()
731
+ return self.api_client.response_deserialize(
732
+ response_data=response_data,
733
+ response_types_map=_response_types_map,
734
+ )
735
+
736
+
737
+ @validate_call
738
+ def get_msp_device_upgrade_run_without_preload_content(
739
+ self,
740
+ msp_upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
741
+ _request_timeout: Union[
742
+ None,
743
+ Annotated[StrictFloat, Field(gt=0)],
744
+ Tuple[
745
+ Annotated[StrictFloat, Field(gt=0)],
746
+ Annotated[StrictFloat, Field(gt=0)]
747
+ ]
748
+ ] = None,
749
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
750
+ _content_type: Optional[StrictStr] = None,
751
+ _headers: Optional[Dict[StrictStr, Any]] = None,
752
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
753
+ ) -> RESTResponseType:
754
+ """Get MSP Device Upgrade Run
755
+
756
+ Get a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
757
+
758
+ :param msp_upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
759
+ :type msp_upgrade_run_uid: str
760
+ :param _request_timeout: timeout setting for this request. If one
761
+ number provided, it will be total request
762
+ timeout. It can also be a pair (tuple) of
763
+ (connection, read) timeouts.
764
+ :type _request_timeout: int, tuple(int, int), optional
765
+ :param _request_auth: set to override the auth_settings for an a single
766
+ request; this effectively ignores the
767
+ authentication in the spec for a single request.
768
+ :type _request_auth: dict, optional
769
+ :param _content_type: force content-type for the request.
770
+ :type _content_type: str, Optional
771
+ :param _headers: set to override the headers for a single
772
+ request; this effectively ignores the headers
773
+ in the spec for a single request.
774
+ :type _headers: dict, optional
775
+ :param _host_index: set to override the host_index for a single
776
+ request; this effectively ignores the host_index
777
+ in the spec for a single request.
778
+ :type _host_index: int, optional
779
+ :return: Returns the result object.
780
+ """ # noqa: E501
781
+
782
+ _param = self._get_msp_device_upgrade_run_serialize(
783
+ msp_upgrade_run_uid=msp_upgrade_run_uid,
784
+ _request_auth=_request_auth,
785
+ _content_type=_content_type,
786
+ _headers=_headers,
787
+ _host_index=_host_index
788
+ )
789
+
790
+ _response_types_map: Dict[str, Optional[str]] = {
791
+ '200': "MspUpgradeRunDto",
792
+ '404': "CommonApiError",
793
+ '500': "CommonApiError",
794
+ }
795
+ response_data = self.api_client.call_api(
796
+ *_param,
797
+ _request_timeout=_request_timeout
798
+ )
799
+ return response_data.response
800
+
801
+
802
+ def _get_msp_device_upgrade_run_serialize(
803
+ self,
804
+ msp_upgrade_run_uid,
805
+ _request_auth,
806
+ _content_type,
807
+ _headers,
808
+ _host_index,
809
+ ) -> RequestSerialized:
810
+
811
+ _host = None
812
+
813
+ _collection_formats: Dict[str, str] = {
814
+ }
815
+
816
+ _path_params: Dict[str, str] = {}
817
+ _query_params: List[Tuple[str, str]] = []
818
+ _header_params: Dict[str, Optional[str]] = _headers or {}
819
+ _form_params: List[Tuple[str, str]] = []
820
+ _files: Dict[str, str] = {}
821
+ _body_params: Optional[bytes] = None
822
+
823
+ # process the path parameters
824
+ if msp_upgrade_run_uid is not None:
825
+ _path_params['mspUpgradeRunUid'] = msp_upgrade_run_uid
826
+ # process the query parameters
827
+ # process the header parameters
828
+ # process the form parameters
829
+ # process the body parameter
830
+
831
+
832
+ # set the HTTP header `Accept`
833
+ _header_params['Accept'] = self.api_client.select_header_accept(
834
+ [
835
+ 'application/json'
836
+ ]
837
+ )
838
+
839
+
840
+ # authentication setting
841
+ _auth_settings: List[str] = [
842
+ 'bearerAuth'
843
+ ]
844
+
845
+ return self.api_client.param_serialize(
846
+ method='GET',
847
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs/{mspUpgradeRunUid}',
848
+ path_params=_path_params,
849
+ query_params=_query_params,
850
+ header_params=_header_params,
851
+ body=_body_params,
852
+ post_params=_form_params,
853
+ files=_files,
854
+ auth_settings=_auth_settings,
855
+ collection_formats=_collection_formats,
856
+ _host=_host,
857
+ _request_auth=_request_auth
858
+ )
859
+
860
+
861
+
862
+
863
+ @validate_call
864
+ def get_msp_device_upgrade_runs(
865
+ self,
866
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
867
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
868
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
869
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
870
+ _request_timeout: Union[
871
+ None,
872
+ Annotated[StrictFloat, Field(gt=0)],
873
+ Tuple[
874
+ Annotated[StrictFloat, Field(gt=0)],
875
+ Annotated[StrictFloat, Field(gt=0)]
876
+ ]
877
+ ] = None,
878
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
879
+ _content_type: Optional[StrictStr] = None,
880
+ _headers: Optional[Dict[StrictStr, Any]] = None,
881
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
882
+ ) -> MspUpgradeRunDtoPage:
883
+ """Get MSP Device Upgrade Runs
884
+
885
+ Get a list of MSP device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
886
+
887
+ :param limit: Number of results to retrieve.
888
+ :type limit: str
889
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
890
+ :type offset: str
891
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
892
+ :type q: str
893
+ :param sort: The fields to sort results by.
894
+ :type sort: List[str]
895
+ :param _request_timeout: timeout setting for this request. If one
896
+ number provided, it will be total request
897
+ timeout. It can also be a pair (tuple) of
898
+ (connection, read) timeouts.
899
+ :type _request_timeout: int, tuple(int, int), optional
900
+ :param _request_auth: set to override the auth_settings for an a single
901
+ request; this effectively ignores the
902
+ authentication in the spec for a single request.
903
+ :type _request_auth: dict, optional
904
+ :param _content_type: force content-type for the request.
905
+ :type _content_type: str, Optional
906
+ :param _headers: set to override the headers for a single
907
+ request; this effectively ignores the headers
908
+ in the spec for a single request.
909
+ :type _headers: dict, optional
910
+ :param _host_index: set to override the host_index for a single
911
+ request; this effectively ignores the host_index
912
+ in the spec for a single request.
913
+ :type _host_index: int, optional
914
+ :return: Returns the result object.
915
+ """ # noqa: E501
916
+
917
+ _param = self._get_msp_device_upgrade_runs_serialize(
918
+ limit=limit,
919
+ offset=offset,
920
+ q=q,
921
+ sort=sort,
922
+ _request_auth=_request_auth,
923
+ _content_type=_content_type,
924
+ _headers=_headers,
925
+ _host_index=_host_index
926
+ )
927
+
928
+ _response_types_map: Dict[str, Optional[str]] = {
929
+ '200': "MspUpgradeRunDtoPage",
930
+ '500': "CommonApiError",
931
+ }
932
+ response_data = self.api_client.call_api(
933
+ *_param,
934
+ _request_timeout=_request_timeout
935
+ )
936
+ response_data.read()
937
+ return self.api_client.response_deserialize(
938
+ response_data=response_data,
939
+ response_types_map=_response_types_map,
940
+ ).data
941
+
942
+
943
+ @validate_call
944
+ def get_msp_device_upgrade_runs_with_http_info(
945
+ self,
946
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
947
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
948
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
949
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
950
+ _request_timeout: Union[
951
+ None,
952
+ Annotated[StrictFloat, Field(gt=0)],
953
+ Tuple[
954
+ Annotated[StrictFloat, Field(gt=0)],
955
+ Annotated[StrictFloat, Field(gt=0)]
956
+ ]
957
+ ] = None,
958
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
959
+ _content_type: Optional[StrictStr] = None,
960
+ _headers: Optional[Dict[StrictStr, Any]] = None,
961
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
962
+ ) -> ApiResponse[MspUpgradeRunDtoPage]:
963
+ """Get MSP Device Upgrade Runs
964
+
965
+ Get a list of MSP device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
966
+
967
+ :param limit: Number of results to retrieve.
968
+ :type limit: str
969
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
970
+ :type offset: str
971
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
972
+ :type q: str
973
+ :param sort: The fields to sort results by.
974
+ :type sort: List[str]
975
+ :param _request_timeout: timeout setting for this request. If one
976
+ number provided, it will be total request
977
+ timeout. It can also be a pair (tuple) of
978
+ (connection, read) timeouts.
979
+ :type _request_timeout: int, tuple(int, int), optional
980
+ :param _request_auth: set to override the auth_settings for an a single
981
+ request; this effectively ignores the
982
+ authentication in the spec for a single request.
983
+ :type _request_auth: dict, optional
984
+ :param _content_type: force content-type for the request.
985
+ :type _content_type: str, Optional
986
+ :param _headers: set to override the headers for a single
987
+ request; this effectively ignores the headers
988
+ in the spec for a single request.
989
+ :type _headers: dict, optional
990
+ :param _host_index: set to override the host_index for a single
991
+ request; this effectively ignores the host_index
992
+ in the spec for a single request.
993
+ :type _host_index: int, optional
994
+ :return: Returns the result object.
995
+ """ # noqa: E501
996
+
997
+ _param = self._get_msp_device_upgrade_runs_serialize(
998
+ limit=limit,
999
+ offset=offset,
1000
+ q=q,
1001
+ sort=sort,
1002
+ _request_auth=_request_auth,
1003
+ _content_type=_content_type,
1004
+ _headers=_headers,
1005
+ _host_index=_host_index
1006
+ )
1007
+
1008
+ _response_types_map: Dict[str, Optional[str]] = {
1009
+ '200': "MspUpgradeRunDtoPage",
1010
+ '500': "CommonApiError",
1011
+ }
1012
+ response_data = self.api_client.call_api(
1013
+ *_param,
1014
+ _request_timeout=_request_timeout
1015
+ )
1016
+ response_data.read()
1017
+ return self.api_client.response_deserialize(
1018
+ response_data=response_data,
1019
+ response_types_map=_response_types_map,
1020
+ )
1021
+
1022
+
1023
+ @validate_call
1024
+ def get_msp_device_upgrade_runs_without_preload_content(
1025
+ self,
1026
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
1027
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1028
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1029
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
1030
+ _request_timeout: Union[
1031
+ None,
1032
+ Annotated[StrictFloat, Field(gt=0)],
1033
+ Tuple[
1034
+ Annotated[StrictFloat, Field(gt=0)],
1035
+ Annotated[StrictFloat, Field(gt=0)]
1036
+ ]
1037
+ ] = None,
1038
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1039
+ _content_type: Optional[StrictStr] = None,
1040
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1041
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1042
+ ) -> RESTResponseType:
1043
+ """Get MSP Device Upgrade Runs
1044
+
1045
+ Get a list of MSP device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
1046
+
1047
+ :param limit: Number of results to retrieve.
1048
+ :type limit: str
1049
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1050
+ :type offset: str
1051
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1052
+ :type q: str
1053
+ :param sort: The fields to sort results by.
1054
+ :type sort: List[str]
1055
+ :param _request_timeout: timeout setting for this request. If one
1056
+ number provided, it will be total request
1057
+ timeout. It can also be a pair (tuple) of
1058
+ (connection, read) timeouts.
1059
+ :type _request_timeout: int, tuple(int, int), optional
1060
+ :param _request_auth: set to override the auth_settings for an a single
1061
+ request; this effectively ignores the
1062
+ authentication in the spec for a single request.
1063
+ :type _request_auth: dict, optional
1064
+ :param _content_type: force content-type for the request.
1065
+ :type _content_type: str, Optional
1066
+ :param _headers: set to override the headers for a single
1067
+ request; this effectively ignores the headers
1068
+ in the spec for a single request.
1069
+ :type _headers: dict, optional
1070
+ :param _host_index: set to override the host_index for a single
1071
+ request; this effectively ignores the host_index
1072
+ in the spec for a single request.
1073
+ :type _host_index: int, optional
1074
+ :return: Returns the result object.
1075
+ """ # noqa: E501
1076
+
1077
+ _param = self._get_msp_device_upgrade_runs_serialize(
1078
+ limit=limit,
1079
+ offset=offset,
1080
+ q=q,
1081
+ sort=sort,
1082
+ _request_auth=_request_auth,
1083
+ _content_type=_content_type,
1084
+ _headers=_headers,
1085
+ _host_index=_host_index
1086
+ )
1087
+
1088
+ _response_types_map: Dict[str, Optional[str]] = {
1089
+ '200': "MspUpgradeRunDtoPage",
1090
+ '500': "CommonApiError",
1091
+ }
1092
+ response_data = self.api_client.call_api(
1093
+ *_param,
1094
+ _request_timeout=_request_timeout
1095
+ )
1096
+ return response_data.response
1097
+
1098
+
1099
+ def _get_msp_device_upgrade_runs_serialize(
1100
+ self,
1101
+ limit,
1102
+ offset,
1103
+ q,
1104
+ sort,
1105
+ _request_auth,
1106
+ _content_type,
1107
+ _headers,
1108
+ _host_index,
1109
+ ) -> RequestSerialized:
1110
+
1111
+ _host = None
1112
+
1113
+ _collection_formats: Dict[str, str] = {
1114
+ 'sort': 'multi',
1115
+ }
1116
+
1117
+ _path_params: Dict[str, str] = {}
1118
+ _query_params: List[Tuple[str, str]] = []
1119
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1120
+ _form_params: List[Tuple[str, str]] = []
1121
+ _files: Dict[str, str] = {}
1122
+ _body_params: Optional[bytes] = None
1123
+
1124
+ # process the path parameters
1125
+ # process the query parameters
1126
+ if limit is not None:
1127
+
1128
+ _query_params.append(('limit', limit))
1129
+
1130
+ if offset is not None:
1131
+
1132
+ _query_params.append(('offset', offset))
1133
+
1134
+ if q is not None:
1135
+
1136
+ _query_params.append(('q', q))
277
1137
 
278
- _query_params.append(('deviceUids', device_uids))
1138
+ if sort is not None:
279
1139
 
1140
+ _query_params.append(('sort', sort))
1141
+
1142
+ # process the header parameters
1143
+ # process the form parameters
1144
+ # process the body parameter
1145
+
1146
+
1147
+ # set the HTTP header `Accept`
1148
+ _header_params['Accept'] = self.api_client.select_header_accept(
1149
+ [
1150
+ 'application/json'
1151
+ ]
1152
+ )
1153
+
1154
+
1155
+ # authentication setting
1156
+ _auth_settings: List[str] = [
1157
+ 'bearerAuth'
1158
+ ]
1159
+
1160
+ return self.api_client.param_serialize(
1161
+ method='GET',
1162
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs',
1163
+ path_params=_path_params,
1164
+ query_params=_query_params,
1165
+ header_params=_header_params,
1166
+ body=_body_params,
1167
+ post_params=_form_params,
1168
+ files=_files,
1169
+ auth_settings=_auth_settings,
1170
+ collection_formats=_collection_formats,
1171
+ _host=_host,
1172
+ _request_auth=_request_auth
1173
+ )
1174
+
1175
+
1176
+
1177
+
1178
+ @validate_call
1179
+ def get_msp_ftd_compatible_upgrade_versions(
1180
+ self,
1181
+ upgrade_version_uid: Annotated[StrictStr, Field(description="Unique identifier, represented as a UUID, of the Device Upgrade Version object in SCC Firewall Manager.")],
1182
+ _request_timeout: Union[
1183
+ None,
1184
+ Annotated[StrictFloat, Field(gt=0)],
1185
+ Tuple[
1186
+ Annotated[StrictFloat, Field(gt=0)],
1187
+ Annotated[StrictFloat, Field(gt=0)]
1188
+ ]
1189
+ ] = None,
1190
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1191
+ _content_type: Optional[StrictStr] = None,
1192
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1193
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1194
+ ) -> UpgradeCompatibilityInfoDto:
1195
+ """Get compatible FTD upgrade versions
1196
+
1197
+ Get a Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1198
+
1199
+ :param upgrade_version_uid: Unique identifier, represented as a UUID, of the Device Upgrade Version object in SCC Firewall Manager. (required)
1200
+ :type upgrade_version_uid: str
1201
+ :param _request_timeout: timeout setting for this request. If one
1202
+ number provided, it will be total request
1203
+ timeout. It can also be a pair (tuple) of
1204
+ (connection, read) timeouts.
1205
+ :type _request_timeout: int, tuple(int, int), optional
1206
+ :param _request_auth: set to override the auth_settings for an a single
1207
+ request; this effectively ignores the
1208
+ authentication in the spec for a single request.
1209
+ :type _request_auth: dict, optional
1210
+ :param _content_type: force content-type for the request.
1211
+ :type _content_type: str, Optional
1212
+ :param _headers: set to override the headers for a single
1213
+ request; this effectively ignores the headers
1214
+ in the spec for a single request.
1215
+ :type _headers: dict, optional
1216
+ :param _host_index: set to override the host_index for a single
1217
+ request; this effectively ignores the host_index
1218
+ in the spec for a single request.
1219
+ :type _host_index: int, optional
1220
+ :return: Returns the result object.
1221
+ """ # noqa: E501
1222
+
1223
+ _param = self._get_msp_ftd_compatible_upgrade_versions_serialize(
1224
+ upgrade_version_uid=upgrade_version_uid,
1225
+ _request_auth=_request_auth,
1226
+ _content_type=_content_type,
1227
+ _headers=_headers,
1228
+ _host_index=_host_index
1229
+ )
1230
+
1231
+ _response_types_map: Dict[str, Optional[str]] = {
1232
+ '200': "UpgradeCompatibilityInfoDto",
1233
+ '400': "CommonApiError",
1234
+ '401': "AuthenticationError",
1235
+ '403': "CommonApiError",
1236
+ '404': "CommonApiError",
1237
+ '500': "CommonApiError",
1238
+ }
1239
+ response_data = self.api_client.call_api(
1240
+ *_param,
1241
+ _request_timeout=_request_timeout
1242
+ )
1243
+ response_data.read()
1244
+ return self.api_client.response_deserialize(
1245
+ response_data=response_data,
1246
+ response_types_map=_response_types_map,
1247
+ ).data
1248
+
1249
+
1250
+ @validate_call
1251
+ def get_msp_ftd_compatible_upgrade_versions_with_http_info(
1252
+ self,
1253
+ upgrade_version_uid: Annotated[StrictStr, Field(description="Unique identifier, represented as a UUID, of the Device Upgrade Version object in SCC Firewall Manager.")],
1254
+ _request_timeout: Union[
1255
+ None,
1256
+ Annotated[StrictFloat, Field(gt=0)],
1257
+ Tuple[
1258
+ Annotated[StrictFloat, Field(gt=0)],
1259
+ Annotated[StrictFloat, Field(gt=0)]
1260
+ ]
1261
+ ] = None,
1262
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1263
+ _content_type: Optional[StrictStr] = None,
1264
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1265
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1266
+ ) -> ApiResponse[UpgradeCompatibilityInfoDto]:
1267
+ """Get compatible FTD upgrade versions
1268
+
1269
+ Get a Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1270
+
1271
+ :param upgrade_version_uid: Unique identifier, represented as a UUID, of the Device Upgrade Version object in SCC Firewall Manager. (required)
1272
+ :type upgrade_version_uid: str
1273
+ :param _request_timeout: timeout setting for this request. If one
1274
+ number provided, it will be total request
1275
+ timeout. It can also be a pair (tuple) of
1276
+ (connection, read) timeouts.
1277
+ :type _request_timeout: int, tuple(int, int), optional
1278
+ :param _request_auth: set to override the auth_settings for an a single
1279
+ request; this effectively ignores the
1280
+ authentication in the spec for a single request.
1281
+ :type _request_auth: dict, optional
1282
+ :param _content_type: force content-type for the request.
1283
+ :type _content_type: str, Optional
1284
+ :param _headers: set to override the headers for a single
1285
+ request; this effectively ignores the headers
1286
+ in the spec for a single request.
1287
+ :type _headers: dict, optional
1288
+ :param _host_index: set to override the host_index for a single
1289
+ request; this effectively ignores the host_index
1290
+ in the spec for a single request.
1291
+ :type _host_index: int, optional
1292
+ :return: Returns the result object.
1293
+ """ # noqa: E501
1294
+
1295
+ _param = self._get_msp_ftd_compatible_upgrade_versions_serialize(
1296
+ upgrade_version_uid=upgrade_version_uid,
1297
+ _request_auth=_request_auth,
1298
+ _content_type=_content_type,
1299
+ _headers=_headers,
1300
+ _host_index=_host_index
1301
+ )
1302
+
1303
+ _response_types_map: Dict[str, Optional[str]] = {
1304
+ '200': "UpgradeCompatibilityInfoDto",
1305
+ '400': "CommonApiError",
1306
+ '401': "AuthenticationError",
1307
+ '403': "CommonApiError",
1308
+ '404': "CommonApiError",
1309
+ '500': "CommonApiError",
1310
+ }
1311
+ response_data = self.api_client.call_api(
1312
+ *_param,
1313
+ _request_timeout=_request_timeout
1314
+ )
1315
+ response_data.read()
1316
+ return self.api_client.response_deserialize(
1317
+ response_data=response_data,
1318
+ response_types_map=_response_types_map,
1319
+ )
1320
+
1321
+
1322
+ @validate_call
1323
+ def get_msp_ftd_compatible_upgrade_versions_without_preload_content(
1324
+ self,
1325
+ upgrade_version_uid: Annotated[StrictStr, Field(description="Unique identifier, represented as a UUID, of the Device Upgrade Version object in SCC Firewall Manager.")],
1326
+ _request_timeout: Union[
1327
+ None,
1328
+ Annotated[StrictFloat, Field(gt=0)],
1329
+ Tuple[
1330
+ Annotated[StrictFloat, Field(gt=0)],
1331
+ Annotated[StrictFloat, Field(gt=0)]
1332
+ ]
1333
+ ] = None,
1334
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1335
+ _content_type: Optional[StrictStr] = None,
1336
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1337
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1338
+ ) -> RESTResponseType:
1339
+ """Get compatible FTD upgrade versions
1340
+
1341
+ Get a Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1342
+
1343
+ :param upgrade_version_uid: Unique identifier, represented as a UUID, of the Device Upgrade Version object in SCC Firewall Manager. (required)
1344
+ :type upgrade_version_uid: str
1345
+ :param _request_timeout: timeout setting for this request. If one
1346
+ number provided, it will be total request
1347
+ timeout. It can also be a pair (tuple) of
1348
+ (connection, read) timeouts.
1349
+ :type _request_timeout: int, tuple(int, int), optional
1350
+ :param _request_auth: set to override the auth_settings for an a single
1351
+ request; this effectively ignores the
1352
+ authentication in the spec for a single request.
1353
+ :type _request_auth: dict, optional
1354
+ :param _content_type: force content-type for the request.
1355
+ :type _content_type: str, Optional
1356
+ :param _headers: set to override the headers for a single
1357
+ request; this effectively ignores the headers
1358
+ in the spec for a single request.
1359
+ :type _headers: dict, optional
1360
+ :param _host_index: set to override the host_index for a single
1361
+ request; this effectively ignores the host_index
1362
+ in the spec for a single request.
1363
+ :type _host_index: int, optional
1364
+ :return: Returns the result object.
1365
+ """ # noqa: E501
1366
+
1367
+ _param = self._get_msp_ftd_compatible_upgrade_versions_serialize(
1368
+ upgrade_version_uid=upgrade_version_uid,
1369
+ _request_auth=_request_auth,
1370
+ _content_type=_content_type,
1371
+ _headers=_headers,
1372
+ _host_index=_host_index
1373
+ )
1374
+
1375
+ _response_types_map: Dict[str, Optional[str]] = {
1376
+ '200': "UpgradeCompatibilityInfoDto",
1377
+ '400': "CommonApiError",
1378
+ '401': "AuthenticationError",
1379
+ '403': "CommonApiError",
1380
+ '404': "CommonApiError",
1381
+ '500': "CommonApiError",
1382
+ }
1383
+ response_data = self.api_client.call_api(
1384
+ *_param,
1385
+ _request_timeout=_request_timeout
1386
+ )
1387
+ return response_data.response
1388
+
1389
+
1390
+ def _get_msp_ftd_compatible_upgrade_versions_serialize(
1391
+ self,
1392
+ upgrade_version_uid,
1393
+ _request_auth,
1394
+ _content_type,
1395
+ _headers,
1396
+ _host_index,
1397
+ ) -> RequestSerialized:
1398
+
1399
+ _host = None
1400
+
1401
+ _collection_formats: Dict[str, str] = {
1402
+ }
1403
+
1404
+ _path_params: Dict[str, str] = {}
1405
+ _query_params: List[Tuple[str, str]] = []
1406
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1407
+ _form_params: List[Tuple[str, str]] = []
1408
+ _files: Dict[str, str] = {}
1409
+ _body_params: Optional[bytes] = None
1410
+
1411
+ # process the path parameters
1412
+ if upgrade_version_uid is not None:
1413
+ _path_params['upgradeVersionUid'] = upgrade_version_uid
1414
+ # process the query parameters
1415
+ # process the header parameters
1416
+ # process the form parameters
1417
+ # process the body parameter
1418
+
1419
+
1420
+ # set the HTTP header `Accept`
1421
+ _header_params['Accept'] = self.api_client.select_header_accept(
1422
+ [
1423
+ 'application/json'
1424
+ ]
1425
+ )
1426
+
1427
+
1428
+ # authentication setting
1429
+ _auth_settings: List[str] = [
1430
+ 'bearerAuth'
1431
+ ]
1432
+
1433
+ return self.api_client.param_serialize(
1434
+ method='GET',
1435
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/versions/{upgradeVersionUid}',
1436
+ path_params=_path_params,
1437
+ query_params=_query_params,
1438
+ header_params=_header_params,
1439
+ body=_body_params,
1440
+ post_params=_form_params,
1441
+ files=_files,
1442
+ auth_settings=_auth_settings,
1443
+ collection_formats=_collection_formats,
1444
+ _host=_host,
1445
+ _request_auth=_request_auth
1446
+ )
1447
+
1448
+
1449
+
1450
+
1451
+ @validate_call
1452
+ def get_msp_upgrade_runs_attribute_values(
1453
+ self,
1454
+ _request_timeout: Union[
1455
+ None,
1456
+ Annotated[StrictFloat, Field(gt=0)],
1457
+ Tuple[
1458
+ Annotated[StrictFloat, Field(gt=0)],
1459
+ Annotated[StrictFloat, Field(gt=0)]
1460
+ ]
1461
+ ] = None,
1462
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1463
+ _content_type: Optional[StrictStr] = None,
1464
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1465
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1466
+ ) -> MspUpgradeRunsAttributeValues:
1467
+ """Get distinct attribute values for MSP upgrade runs
1468
+
1469
+ Get distinct attribute values for fields in the MSP upgrade runs.
1470
+
1471
+ :param _request_timeout: timeout setting for this request. If one
1472
+ number provided, it will be total request
1473
+ timeout. It can also be a pair (tuple) of
1474
+ (connection, read) timeouts.
1475
+ :type _request_timeout: int, tuple(int, int), optional
1476
+ :param _request_auth: set to override the auth_settings for an a single
1477
+ request; this effectively ignores the
1478
+ authentication in the spec for a single request.
1479
+ :type _request_auth: dict, optional
1480
+ :param _content_type: force content-type for the request.
1481
+ :type _content_type: str, Optional
1482
+ :param _headers: set to override the headers for a single
1483
+ request; this effectively ignores the headers
1484
+ in the spec for a single request.
1485
+ :type _headers: dict, optional
1486
+ :param _host_index: set to override the host_index for a single
1487
+ request; this effectively ignores the host_index
1488
+ in the spec for a single request.
1489
+ :type _host_index: int, optional
1490
+ :return: Returns the result object.
1491
+ """ # noqa: E501
1492
+
1493
+ _param = self._get_msp_upgrade_runs_attribute_values_serialize(
1494
+ _request_auth=_request_auth,
1495
+ _content_type=_content_type,
1496
+ _headers=_headers,
1497
+ _host_index=_host_index
1498
+ )
1499
+
1500
+ _response_types_map: Dict[str, Optional[str]] = {
1501
+ '200': "MspUpgradeRunsAttributeValues",
1502
+ '500': "CommonApiError",
1503
+ }
1504
+ response_data = self.api_client.call_api(
1505
+ *_param,
1506
+ _request_timeout=_request_timeout
1507
+ )
1508
+ response_data.read()
1509
+ return self.api_client.response_deserialize(
1510
+ response_data=response_data,
1511
+ response_types_map=_response_types_map,
1512
+ ).data
1513
+
1514
+
1515
+ @validate_call
1516
+ def get_msp_upgrade_runs_attribute_values_with_http_info(
1517
+ self,
1518
+ _request_timeout: Union[
1519
+ None,
1520
+ Annotated[StrictFloat, Field(gt=0)],
1521
+ Tuple[
1522
+ Annotated[StrictFloat, Field(gt=0)],
1523
+ Annotated[StrictFloat, Field(gt=0)]
1524
+ ]
1525
+ ] = None,
1526
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1527
+ _content_type: Optional[StrictStr] = None,
1528
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1529
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1530
+ ) -> ApiResponse[MspUpgradeRunsAttributeValues]:
1531
+ """Get distinct attribute values for MSP upgrade runs
1532
+
1533
+ Get distinct attribute values for fields in the MSP upgrade runs.
1534
+
1535
+ :param _request_timeout: timeout setting for this request. If one
1536
+ number provided, it will be total request
1537
+ timeout. It can also be a pair (tuple) of
1538
+ (connection, read) timeouts.
1539
+ :type _request_timeout: int, tuple(int, int), optional
1540
+ :param _request_auth: set to override the auth_settings for an a single
1541
+ request; this effectively ignores the
1542
+ authentication in the spec for a single request.
1543
+ :type _request_auth: dict, optional
1544
+ :param _content_type: force content-type for the request.
1545
+ :type _content_type: str, Optional
1546
+ :param _headers: set to override the headers for a single
1547
+ request; this effectively ignores the headers
1548
+ in the spec for a single request.
1549
+ :type _headers: dict, optional
1550
+ :param _host_index: set to override the host_index for a single
1551
+ request; this effectively ignores the host_index
1552
+ in the spec for a single request.
1553
+ :type _host_index: int, optional
1554
+ :return: Returns the result object.
1555
+ """ # noqa: E501
1556
+
1557
+ _param = self._get_msp_upgrade_runs_attribute_values_serialize(
1558
+ _request_auth=_request_auth,
1559
+ _content_type=_content_type,
1560
+ _headers=_headers,
1561
+ _host_index=_host_index
1562
+ )
1563
+
1564
+ _response_types_map: Dict[str, Optional[str]] = {
1565
+ '200': "MspUpgradeRunsAttributeValues",
1566
+ '500': "CommonApiError",
1567
+ }
1568
+ response_data = self.api_client.call_api(
1569
+ *_param,
1570
+ _request_timeout=_request_timeout
1571
+ )
1572
+ response_data.read()
1573
+ return self.api_client.response_deserialize(
1574
+ response_data=response_data,
1575
+ response_types_map=_response_types_map,
1576
+ )
1577
+
1578
+
1579
+ @validate_call
1580
+ def get_msp_upgrade_runs_attribute_values_without_preload_content(
1581
+ self,
1582
+ _request_timeout: Union[
1583
+ None,
1584
+ Annotated[StrictFloat, Field(gt=0)],
1585
+ Tuple[
1586
+ Annotated[StrictFloat, Field(gt=0)],
1587
+ Annotated[StrictFloat, Field(gt=0)]
1588
+ ]
1589
+ ] = None,
1590
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1591
+ _content_type: Optional[StrictStr] = None,
1592
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1593
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1594
+ ) -> RESTResponseType:
1595
+ """Get distinct attribute values for MSP upgrade runs
1596
+
1597
+ Get distinct attribute values for fields in the MSP upgrade runs.
1598
+
1599
+ :param _request_timeout: timeout setting for this request. If one
1600
+ number provided, it will be total request
1601
+ timeout. It can also be a pair (tuple) of
1602
+ (connection, read) timeouts.
1603
+ :type _request_timeout: int, tuple(int, int), optional
1604
+ :param _request_auth: set to override the auth_settings for an a single
1605
+ request; this effectively ignores the
1606
+ authentication in the spec for a single request.
1607
+ :type _request_auth: dict, optional
1608
+ :param _content_type: force content-type for the request.
1609
+ :type _content_type: str, Optional
1610
+ :param _headers: set to override the headers for a single
1611
+ request; this effectively ignores the headers
1612
+ in the spec for a single request.
1613
+ :type _headers: dict, optional
1614
+ :param _host_index: set to override the host_index for a single
1615
+ request; this effectively ignores the host_index
1616
+ in the spec for a single request.
1617
+ :type _host_index: int, optional
1618
+ :return: Returns the result object.
1619
+ """ # noqa: E501
1620
+
1621
+ _param = self._get_msp_upgrade_runs_attribute_values_serialize(
1622
+ _request_auth=_request_auth,
1623
+ _content_type=_content_type,
1624
+ _headers=_headers,
1625
+ _host_index=_host_index
1626
+ )
1627
+
1628
+ _response_types_map: Dict[str, Optional[str]] = {
1629
+ '200': "MspUpgradeRunsAttributeValues",
1630
+ '500': "CommonApiError",
1631
+ }
1632
+ response_data = self.api_client.call_api(
1633
+ *_param,
1634
+ _request_timeout=_request_timeout
1635
+ )
1636
+ return response_data.response
1637
+
1638
+
1639
+ def _get_msp_upgrade_runs_attribute_values_serialize(
1640
+ self,
1641
+ _request_auth,
1642
+ _content_type,
1643
+ _headers,
1644
+ _host_index,
1645
+ ) -> RequestSerialized:
1646
+
1647
+ _host = None
1648
+
1649
+ _collection_formats: Dict[str, str] = {
1650
+ }
1651
+
1652
+ _path_params: Dict[str, str] = {}
1653
+ _query_params: List[Tuple[str, str]] = []
1654
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1655
+ _form_params: List[Tuple[str, str]] = []
1656
+ _files: Dict[str, str] = {}
1657
+ _body_params: Optional[bytes] = None
1658
+
1659
+ # process the path parameters
1660
+ # process the query parameters
280
1661
  # process the header parameters
281
1662
  # process the form parameters
282
1663
  # process the body parameter
@@ -297,7 +1678,281 @@ class MSPDeviceUpgradesApi:
297
1678
 
298
1679
  return self.api_client.param_serialize(
299
1680
  method='GET',
300
- resource_path='/v1/msp/inventory/devices/ftds/upgrades/versions',
1681
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs/attribute-values',
1682
+ path_params=_path_params,
1683
+ query_params=_query_params,
1684
+ header_params=_header_params,
1685
+ body=_body_params,
1686
+ post_params=_form_params,
1687
+ files=_files,
1688
+ auth_settings=_auth_settings,
1689
+ collection_formats=_collection_formats,
1690
+ _host=_host,
1691
+ _request_auth=_request_auth
1692
+ )
1693
+
1694
+
1695
+
1696
+
1697
+ @validate_call
1698
+ def upgrade_msp_managed_ftd_devices(
1699
+ self,
1700
+ msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput,
1701
+ _request_timeout: Union[
1702
+ None,
1703
+ Annotated[StrictFloat, Field(gt=0)],
1704
+ Tuple[
1705
+ Annotated[StrictFloat, Field(gt=0)],
1706
+ Annotated[StrictFloat, Field(gt=0)]
1707
+ ]
1708
+ ] = None,
1709
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1710
+ _content_type: Optional[StrictStr] = None,
1711
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1712
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1713
+ ) -> CdoTransaction:
1714
+ """Upgrade multiple FTDs across multiple tenants
1715
+
1716
+ <p>Asynchronous operation to upgrade multiple FTD devices across managed tenants.</p> <p><strong>Notes:</strong></p> <ul> <li>Maximum of 50 FTD devices per hardware model per managed tenant per request</li> </ul> <p><strong>Response:</strong></p> <ul> <li>Returns a transaction object to track upgrade operation progress</li> <li>Use the transaction ID or the entity UID to monitor the status of the upgrade</li> </ul>
1717
+
1718
+ :param msp_upgrade_ftd_devices_input: (required)
1719
+ :type msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput
1720
+ :param _request_timeout: timeout setting for this request. If one
1721
+ number provided, it will be total request
1722
+ timeout. It can also be a pair (tuple) of
1723
+ (connection, read) timeouts.
1724
+ :type _request_timeout: int, tuple(int, int), optional
1725
+ :param _request_auth: set to override the auth_settings for an a single
1726
+ request; this effectively ignores the
1727
+ authentication in the spec for a single request.
1728
+ :type _request_auth: dict, optional
1729
+ :param _content_type: force content-type for the request.
1730
+ :type _content_type: str, Optional
1731
+ :param _headers: set to override the headers for a single
1732
+ request; this effectively ignores the headers
1733
+ in the spec for a single request.
1734
+ :type _headers: dict, optional
1735
+ :param _host_index: set to override the host_index for a single
1736
+ request; this effectively ignores the host_index
1737
+ in the spec for a single request.
1738
+ :type _host_index: int, optional
1739
+ :return: Returns the result object.
1740
+ """ # noqa: E501
1741
+
1742
+ _param = self._upgrade_msp_managed_ftd_devices_serialize(
1743
+ msp_upgrade_ftd_devices_input=msp_upgrade_ftd_devices_input,
1744
+ _request_auth=_request_auth,
1745
+ _content_type=_content_type,
1746
+ _headers=_headers,
1747
+ _host_index=_host_index
1748
+ )
1749
+
1750
+ _response_types_map: Dict[str, Optional[str]] = {
1751
+ '202': "CdoTransaction",
1752
+ '500': "CommonApiError",
1753
+ }
1754
+ response_data = self.api_client.call_api(
1755
+ *_param,
1756
+ _request_timeout=_request_timeout
1757
+ )
1758
+ response_data.read()
1759
+ return self.api_client.response_deserialize(
1760
+ response_data=response_data,
1761
+ response_types_map=_response_types_map,
1762
+ ).data
1763
+
1764
+
1765
+ @validate_call
1766
+ def upgrade_msp_managed_ftd_devices_with_http_info(
1767
+ self,
1768
+ msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput,
1769
+ _request_timeout: Union[
1770
+ None,
1771
+ Annotated[StrictFloat, Field(gt=0)],
1772
+ Tuple[
1773
+ Annotated[StrictFloat, Field(gt=0)],
1774
+ Annotated[StrictFloat, Field(gt=0)]
1775
+ ]
1776
+ ] = None,
1777
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1778
+ _content_type: Optional[StrictStr] = None,
1779
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1780
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1781
+ ) -> ApiResponse[CdoTransaction]:
1782
+ """Upgrade multiple FTDs across multiple tenants
1783
+
1784
+ <p>Asynchronous operation to upgrade multiple FTD devices across managed tenants.</p> <p><strong>Notes:</strong></p> <ul> <li>Maximum of 50 FTD devices per hardware model per managed tenant per request</li> </ul> <p><strong>Response:</strong></p> <ul> <li>Returns a transaction object to track upgrade operation progress</li> <li>Use the transaction ID or the entity UID to monitor the status of the upgrade</li> </ul>
1785
+
1786
+ :param msp_upgrade_ftd_devices_input: (required)
1787
+ :type msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput
1788
+ :param _request_timeout: timeout setting for this request. If one
1789
+ number provided, it will be total request
1790
+ timeout. It can also be a pair (tuple) of
1791
+ (connection, read) timeouts.
1792
+ :type _request_timeout: int, tuple(int, int), optional
1793
+ :param _request_auth: set to override the auth_settings for an a single
1794
+ request; this effectively ignores the
1795
+ authentication in the spec for a single request.
1796
+ :type _request_auth: dict, optional
1797
+ :param _content_type: force content-type for the request.
1798
+ :type _content_type: str, Optional
1799
+ :param _headers: set to override the headers for a single
1800
+ request; this effectively ignores the headers
1801
+ in the spec for a single request.
1802
+ :type _headers: dict, optional
1803
+ :param _host_index: set to override the host_index for a single
1804
+ request; this effectively ignores the host_index
1805
+ in the spec for a single request.
1806
+ :type _host_index: int, optional
1807
+ :return: Returns the result object.
1808
+ """ # noqa: E501
1809
+
1810
+ _param = self._upgrade_msp_managed_ftd_devices_serialize(
1811
+ msp_upgrade_ftd_devices_input=msp_upgrade_ftd_devices_input,
1812
+ _request_auth=_request_auth,
1813
+ _content_type=_content_type,
1814
+ _headers=_headers,
1815
+ _host_index=_host_index
1816
+ )
1817
+
1818
+ _response_types_map: Dict[str, Optional[str]] = {
1819
+ '202': "CdoTransaction",
1820
+ '500': "CommonApiError",
1821
+ }
1822
+ response_data = self.api_client.call_api(
1823
+ *_param,
1824
+ _request_timeout=_request_timeout
1825
+ )
1826
+ response_data.read()
1827
+ return self.api_client.response_deserialize(
1828
+ response_data=response_data,
1829
+ response_types_map=_response_types_map,
1830
+ )
1831
+
1832
+
1833
+ @validate_call
1834
+ def upgrade_msp_managed_ftd_devices_without_preload_content(
1835
+ self,
1836
+ msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput,
1837
+ _request_timeout: Union[
1838
+ None,
1839
+ Annotated[StrictFloat, Field(gt=0)],
1840
+ Tuple[
1841
+ Annotated[StrictFloat, Field(gt=0)],
1842
+ Annotated[StrictFloat, Field(gt=0)]
1843
+ ]
1844
+ ] = None,
1845
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1846
+ _content_type: Optional[StrictStr] = None,
1847
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1848
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1849
+ ) -> RESTResponseType:
1850
+ """Upgrade multiple FTDs across multiple tenants
1851
+
1852
+ <p>Asynchronous operation to upgrade multiple FTD devices across managed tenants.</p> <p><strong>Notes:</strong></p> <ul> <li>Maximum of 50 FTD devices per hardware model per managed tenant per request</li> </ul> <p><strong>Response:</strong></p> <ul> <li>Returns a transaction object to track upgrade operation progress</li> <li>Use the transaction ID or the entity UID to monitor the status of the upgrade</li> </ul>
1853
+
1854
+ :param msp_upgrade_ftd_devices_input: (required)
1855
+ :type msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput
1856
+ :param _request_timeout: timeout setting for this request. If one
1857
+ number provided, it will be total request
1858
+ timeout. It can also be a pair (tuple) of
1859
+ (connection, read) timeouts.
1860
+ :type _request_timeout: int, tuple(int, int), optional
1861
+ :param _request_auth: set to override the auth_settings for an a single
1862
+ request; this effectively ignores the
1863
+ authentication in the spec for a single request.
1864
+ :type _request_auth: dict, optional
1865
+ :param _content_type: force content-type for the request.
1866
+ :type _content_type: str, Optional
1867
+ :param _headers: set to override the headers for a single
1868
+ request; this effectively ignores the headers
1869
+ in the spec for a single request.
1870
+ :type _headers: dict, optional
1871
+ :param _host_index: set to override the host_index for a single
1872
+ request; this effectively ignores the host_index
1873
+ in the spec for a single request.
1874
+ :type _host_index: int, optional
1875
+ :return: Returns the result object.
1876
+ """ # noqa: E501
1877
+
1878
+ _param = self._upgrade_msp_managed_ftd_devices_serialize(
1879
+ msp_upgrade_ftd_devices_input=msp_upgrade_ftd_devices_input,
1880
+ _request_auth=_request_auth,
1881
+ _content_type=_content_type,
1882
+ _headers=_headers,
1883
+ _host_index=_host_index
1884
+ )
1885
+
1886
+ _response_types_map: Dict[str, Optional[str]] = {
1887
+ '202': "CdoTransaction",
1888
+ '500': "CommonApiError",
1889
+ }
1890
+ response_data = self.api_client.call_api(
1891
+ *_param,
1892
+ _request_timeout=_request_timeout
1893
+ )
1894
+ return response_data.response
1895
+
1896
+
1897
+ def _upgrade_msp_managed_ftd_devices_serialize(
1898
+ self,
1899
+ msp_upgrade_ftd_devices_input,
1900
+ _request_auth,
1901
+ _content_type,
1902
+ _headers,
1903
+ _host_index,
1904
+ ) -> RequestSerialized:
1905
+
1906
+ _host = None
1907
+
1908
+ _collection_formats: Dict[str, str] = {
1909
+ }
1910
+
1911
+ _path_params: Dict[str, str] = {}
1912
+ _query_params: List[Tuple[str, str]] = []
1913
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1914
+ _form_params: List[Tuple[str, str]] = []
1915
+ _files: Dict[str, str] = {}
1916
+ _body_params: Optional[bytes] = None
1917
+
1918
+ # process the path parameters
1919
+ # process the query parameters
1920
+ # process the header parameters
1921
+ # process the form parameters
1922
+ # process the body parameter
1923
+ if msp_upgrade_ftd_devices_input is not None:
1924
+ _body_params = msp_upgrade_ftd_devices_input
1925
+
1926
+
1927
+ # set the HTTP header `Accept`
1928
+ _header_params['Accept'] = self.api_client.select_header_accept(
1929
+ [
1930
+ 'application/json'
1931
+ ]
1932
+ )
1933
+
1934
+ # set the HTTP header `Content-Type`
1935
+ if _content_type:
1936
+ _header_params['Content-Type'] = _content_type
1937
+ else:
1938
+ _default_content_type = (
1939
+ self.api_client.select_header_content_type(
1940
+ [
1941
+ 'application/json'
1942
+ ]
1943
+ )
1944
+ )
1945
+ if _default_content_type is not None:
1946
+ _header_params['Content-Type'] = _default_content_type
1947
+
1948
+ # authentication setting
1949
+ _auth_settings: List[str] = [
1950
+ 'bearerAuth'
1951
+ ]
1952
+
1953
+ return self.api_client.param_serialize(
1954
+ method='POST',
1955
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/trigger',
301
1956
  path_params=_path_params,
302
1957
  query_params=_query_params,
303
1958
  header_params=_header_params,