scc-firewall-manager-sdk 1.15.27__py3-none-any.whl → 1.15.29__py3-none-any.whl

scc_firewall_manager_sdk/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.15.27"
+__version__ = "1.15.29"
 
 # import apis into sdk package
 from scc_firewall_manager_sdk.api.ai_assistant_api import AIAssistantApi
@@ -163,6 +163,7 @@ from scc_firewall_manager_sdk.models.ftd_deployment_input import FtdDeploymentIn
 from scc_firewall_manager_sdk.models.ftd_ha_info import FtdHaInfo
 from scc_firewall_manager_sdk.models.ftd_multi_device_deployment_input import FtdMultiDeviceDeploymentInput
 from scc_firewall_manager_sdk.models.ftd_registration_input import FtdRegistrationInput
+from scc_firewall_manager_sdk.models.ftd_upgrade_run_dto_page import FtdUpgradeRunDtoPage
 from scc_firewall_manager_sdk.models.ftd_version import FtdVersion
 from scc_firewall_manager_sdk.models.ftd_versions_response import FtdVersionsResponse
 from scc_firewall_manager_sdk.models.global_search_result import GlobalSearchResult
@@ -275,6 +276,7 @@ from scc_firewall_manager_sdk.models.update_request import UpdateRequest
 from scc_firewall_manager_sdk.models.upgrade_asa_device_input import UpgradeAsaDeviceInput
 from scc_firewall_manager_sdk.models.upgrade_ftd_device_input import UpgradeFtdDeviceInput
 from scc_firewall_manager_sdk.models.upgrade_ftd_devices_input import UpgradeFtdDevicesInput
+from scc_firewall_manager_sdk.models.upgrade_run_dto import UpgradeRunDto
 from scc_firewall_manager_sdk.models.url_object_content import UrlObjectContent
 from scc_firewall_manager_sdk.models.user import User
 from scc_firewall_manager_sdk.models.user_create_or_update_input import UserCreateOrUpdateInput

scc_firewall_manager_sdk/api/device_upgrades_api.py

@@ -23,6 +23,7 @@ from typing_extensions import Annotated
 from scc_firewall_manager_sdk.models.asa_compatible_versions_response import AsaCompatibleVersionsResponse
 from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
 from scc_firewall_manager_sdk.models.ftd_compatibility_version import FtdCompatibilityVersion
+from scc_firewall_manager_sdk.models.ftd_upgrade_run_dto_page import FtdUpgradeRunDtoPage
 from scc_firewall_manager_sdk.models.ftd_versions_response import FtdVersionsResponse
 from scc_firewall_manager_sdk.models.upgrade_asa_device_input import UpgradeAsaDeviceInput
 from scc_firewall_manager_sdk.models.upgrade_ftd_device_input import UpgradeFtdDeviceInput
@@ -895,6 +896,600 @@ class DeviceUpgradesApi:
 
 
 
+    @validate_call
+    def get_ftd_device_upgrade_run(
+        self,
+        upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> FtdUpgradeRunDtoPage:
+        """Get FTD Device Upgrade Run
+
+        Get an FTD 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.
+
+        :param upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
+        :type upgrade_run_uid: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_ftd_device_upgrade_run_serialize(
+            upgrade_run_uid=upgrade_run_uid,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "FtdUpgradeRunDtoPage",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_ftd_device_upgrade_run_with_http_info(
+        self,
+        upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[FtdUpgradeRunDtoPage]:
+        """Get FTD Device Upgrade Run
+
+        Get an FTD 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.
+
+        :param upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
+        :type upgrade_run_uid: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_ftd_device_upgrade_run_serialize(
+            upgrade_run_uid=upgrade_run_uid,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "FtdUpgradeRunDtoPage",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_ftd_device_upgrade_run_without_preload_content(
+        self,
+        upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get FTD Device Upgrade Run
+
+        Get an FTD 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.
+
+        :param upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
+        :type upgrade_run_uid: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_ftd_device_upgrade_run_serialize(
+            upgrade_run_uid=upgrade_run_uid,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "FtdUpgradeRunDtoPage",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_ftd_device_upgrade_run_serialize(
+        self,
+        upgrade_run_uid,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if upgrade_run_uid is not None:
+            _path_params['upgradeRunUid'] = upgrade_run_uid
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/inventory/devices/upgrades/runs/{upgradeRunUid}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_ftd_device_upgrade_runs(
+        self,
+        limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
+        offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
+        q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
+        sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> FtdUpgradeRunDtoPage:
+        """Get FTD Device Upgrade Runs
+
+        Get a list of FTD device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
+
+        :param limit: The number of results to retrieve.
+        :type limit: str
+        :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
+        :type offset: str
+        :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
+        :type q: str
+        :param sort: The fields to sort results by.
+        :type sort: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_ftd_device_upgrade_runs_serialize(
+            limit=limit,
+            offset=offset,
+            q=q,
+            sort=sort,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "FtdUpgradeRunDtoPage",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_ftd_device_upgrade_runs_with_http_info(
+        self,
+        limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
+        offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
+        q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
+        sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[FtdUpgradeRunDtoPage]:
+        """Get FTD Device Upgrade Runs
+
+        Get a list of FTD device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
+
+        :param limit: The number of results to retrieve.
+        :type limit: str
+        :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
+        :type offset: str
+        :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
+        :type q: str
+        :param sort: The fields to sort results by.
+        :type sort: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_ftd_device_upgrade_runs_serialize(
+            limit=limit,
+            offset=offset,
+            q=q,
+            sort=sort,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "FtdUpgradeRunDtoPage",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_ftd_device_upgrade_runs_without_preload_content(
+        self,
+        limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
+        offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
+        q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
+        sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get FTD Device Upgrade Runs
+
+        Get a list of FTD device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
+
+        :param limit: The number of results to retrieve.
+        :type limit: str
+        :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
+        :type offset: str
+        :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
+        :type q: str
+        :param sort: The fields to sort results by.
+        :type sort: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_ftd_device_upgrade_runs_serialize(
+            limit=limit,
+            offset=offset,
+            q=q,
+            sort=sort,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "FtdUpgradeRunDtoPage",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_ftd_device_upgrade_runs_serialize(
+        self,
+        limit,
+        offset,
+        q,
+        sort,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            'sort': 'multi',
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        if q is not None:
+            
+            _query_params.append(('q', q))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/inventory/devices/upgrades/runs',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def update_ftd_upgrade_packages_cache(
         self,

scc_firewall_manager_sdk/api_client.py

@@ -88,7 +88,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.15.27/python'
+        self.user_agent = 'OpenAPI-Generator/1.15.29/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

scc_firewall_manager_sdk/configuration.py

@@ -380,7 +380,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.15.0\n"\
-               "SDK Package Version: 1.15.27".\
+               "SDK Package Version: 1.15.29".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

scc_firewall_manager_sdk/models/__init__.py

@@ -123,6 +123,7 @@ from scc_firewall_manager_sdk.models.ftd_deployment_input import FtdDeploymentIn
 from scc_firewall_manager_sdk.models.ftd_ha_info import FtdHaInfo
 from scc_firewall_manager_sdk.models.ftd_multi_device_deployment_input import FtdMultiDeviceDeploymentInput
 from scc_firewall_manager_sdk.models.ftd_registration_input import FtdRegistrationInput
+from scc_firewall_manager_sdk.models.ftd_upgrade_run_dto_page import FtdUpgradeRunDtoPage
 from scc_firewall_manager_sdk.models.ftd_version import FtdVersion
 from scc_firewall_manager_sdk.models.ftd_versions_response import FtdVersionsResponse
 from scc_firewall_manager_sdk.models.global_search_result import GlobalSearchResult
@@ -235,6 +236,7 @@ from scc_firewall_manager_sdk.models.update_request import UpdateRequest
 from scc_firewall_manager_sdk.models.upgrade_asa_device_input import UpgradeAsaDeviceInput
 from scc_firewall_manager_sdk.models.upgrade_ftd_device_input import UpgradeFtdDeviceInput
 from scc_firewall_manager_sdk.models.upgrade_ftd_devices_input import UpgradeFtdDevicesInput
+from scc_firewall_manager_sdk.models.upgrade_run_dto import UpgradeRunDto
 from scc_firewall_manager_sdk.models.url_object_content import UrlObjectContent
 from scc_firewall_manager_sdk.models.user import User
 from scc_firewall_manager_sdk.models.user_create_or_update_input import UserCreateOrUpdateInput

scc_firewall_manager_sdk/models/ftd_upgrade_run_dto_page.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Cisco Security Cloud Control Firewall Manager API
+
+    Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer
+
+    The version of the OpenAPI document: 1.15.0
+    Contact: cdo.tac@cisco.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from scc_firewall_manager_sdk.models.upgrade_run_dto import UpgradeRunDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FtdUpgradeRunDtoPage(BaseModel):
+    """
+    FtdUpgradeRunDtoPage
+    """ # noqa: E501
+    count: Optional[StrictInt] = Field(default=None, description="The total number of results available.")
+    items: Optional[List[UpgradeRunDto]] = Field(default=None, description="The list of items retrieved.")
+    limit: Optional[StrictInt] = Field(default=None, description="The number of results retrieved.")
+    offset: Optional[StrictInt] = Field(default=None, description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")
+    __properties: ClassVar[List[str]] = ["count", "items", "limit", "offset"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FtdUpgradeRunDtoPage from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item in self.items:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FtdUpgradeRunDtoPage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "count": obj.get("count"),
+            "items": [UpgradeRunDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset")
+        })
+        return _obj
+
+

scc_firewall_manager_sdk/models/upgrade_run_dto.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Cisco Security Cloud Control Firewall Manager API
+
+    Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer
+
+    The version of the OpenAPI document: 1.15.0
+    Contact: cdo.tac@cisco.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpgradeRunDto(BaseModel):
+    """
+    UpgradeRunDto
+    """ # noqa: E501
+    device_uids: Optional[List[StrictStr]] = Field(default=None, description="The set of device UIDs that are part of this upgrade run.", alias="deviceUids")
+    name: Optional[StrictStr] = Field(default=None, description="The name of the upgrade run. Upgrade runs names are unique in a tenant in SCC Firewall Manager.")
+    stage_upgrade_only: Optional[StrictBool] = Field(default=None, description="Indicates if this upgrade run is to stage the upgrade on the device. If set to true, the upgrade is not applied on the device.", alias="stageUpgradeOnly")
+    transaction_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the CDO transaction that tracks this upgrade run.", alias="transactionUid")
+    uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the FTD device upgrade run in SCC Firewall Manager.")
+    upgrade_package_uid: Optional[StrictStr] = Field(default=None, description="(cdFMC-managed FTD device upgrades only) The unique identifier of the upgrade package being used.", alias="upgradePackageUid")
+    upgrade_run_status: Optional[StrictStr] = Field(default=None, description="The current status of the upgrade run.", alias="upgradeRunStatus")
+    upgrade_run_type: Optional[StrictStr] = Field(default=None, description="The type of the upgrade run", alias="upgradeRunType")
+    __properties: ClassVar[List[str]] = ["deviceUids", "name", "stageUpgradeOnly", "transactionUid", "uid", "upgradePackageUid", "upgradeRunStatus", "upgradeRunType"]
+
+    @field_validator('upgrade_run_status')
+    def upgrade_run_status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UGPRADE_STAGING_FAILED', 'PERFORMING_UPGRADE', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED']):
+            raise ValueError("must be one of enum values ('UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UGPRADE_STAGING_FAILED', 'PERFORMING_UPGRADE', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED')")
+        return value
+
+    @field_validator('upgrade_run_type')
+    def upgrade_run_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ASA_DEVICE_UPGRADE', 'FTD_DEVICE_UPGRADE', 'FTD_SECURE_CLIENT_UPGRADE', 'ASA_SECURE_CLIENT_UPGRADE']):
+            raise ValueError("must be one of enum values ('ASA_DEVICE_UPGRADE', 'FTD_DEVICE_UPGRADE', 'FTD_SECURE_CLIENT_UPGRADE', 'ASA_SECURE_CLIENT_UPGRADE')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UpgradeRunDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpgradeRunDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "deviceUids": obj.get("deviceUids"),
+            "name": obj.get("name"),
+            "stageUpgradeOnly": obj.get("stageUpgradeOnly"),
+            "transactionUid": obj.get("transactionUid"),
+            "uid": obj.get("uid"),
+            "upgradePackageUid": obj.get("upgradePackageUid"),
+            "upgradeRunStatus": obj.get("upgradeRunStatus"),
+            "upgradeRunType": obj.get("upgradeRunType")
+        })
+        return _obj
+
+

{scc_firewall_manager_sdk-1.15.27.dist-info → scc_firewall_manager_sdk-1.15.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scc-firewall-manager-sdk
-Version: 1.15.27
+Version: 1.15.29
 Summary: Cisco Security Cloud Control Firewall Manager API
 Home-page: 
 Author: Cisco Security Cloud Control TAC

{scc_firewall_manager_sdk-1.15.27.dist-info → scc_firewall_manager_sdk-1.15.29.dist-info}/RECORD

@@ -1,7 +1,7 @@
-scc_firewall_manager_sdk/__init__.py,sha256=K601m1rHdnmmB_hO8nkMqmYH4pIdU5odD7o1mIvo7dc,21658
-scc_firewall_manager_sdk/api_client.py,sha256=558uUr8V6lwbA_BY6WZi6TLEYIfxYOOatLplecqGyHk,25920
+scc_firewall_manager_sdk/__init__.py,sha256=qsqmLoXueAXKJZZMrtRjr2385yBnUZCYQ3XVxSiTCq4,21822
+scc_firewall_manager_sdk/api_client.py,sha256=DtTxkBNwR5Hl6fZQHQy86_s9AOQnFkMSVYePPJJmAGo,25920
 scc_firewall_manager_sdk/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-scc_firewall_manager_sdk/configuration.py,sha256=dK5XiB8JjCS-_0AOx_GSOEai9HagG1h2A8_QMTA_IdY,15992
+scc_firewall_manager_sdk/configuration.py,sha256=lp3-8K0Clt95I1kuFVnPGBV_C4tWDHMNsOQ57sIkkt8,15992
 scc_firewall_manager_sdk/exceptions.py,sha256=u5-7l5MRjP-aS2pNudBzqSw9OI4xVsIvUjw4WCA8LEk,6039
 scc_firewall_manager_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scc_firewall_manager_sdk/rest.py,sha256=cSeilvAB5y-V_10IdXcZ0kOyv5dYW8jeWVhrD6kUDa0,9309
@@ -17,7 +17,7 @@ scc_firewall_manager_sdk/api/command_line_interface_api.py,sha256=_sUPKdTkBkXNbk
 scc_firewall_manager_sdk/api/commands_api.py,sha256=U1cDPCmUAgOPnCOC8KcbcQpLGSwgOBBgHUcKH6JmWK4,33891
 scc_firewall_manager_sdk/api/connectors_api.py,sha256=lw4asxJMtyHTm3sxM6Z7S1O2tbr4ZtbjVrZIalmYagI,59889
 scc_firewall_manager_sdk/api/device_health_api.py,sha256=UoxgUo10Am1kga8U0Kxhb6DDw6d7wpXxzGopsvUJ1JI,62283
-scc_firewall_manager_sdk/api/device_upgrades_api.py,sha256=TOGEt_CpLJgSYCOJyZ-lw3ilHxFcqsZRTskXvWZzDM8,87919
+scc_firewall_manager_sdk/api/device_upgrades_api.py,sha256=hkSAQI1JcHuKdotTCBIq4VzA-UeB2Yu1LL1h_CK37uI,114126
 scc_firewall_manager_sdk/api/inventory_api.py,sha256=EJqDZzqBE4w_klxuo84rSYmrmbinGSJEbSbU6Wqs4Gg,444995
 scc_firewall_manager_sdk/api/meta_api.py,sha256=0T4mIpkOc0FyDIvEN5qhRQbKN4CzOM00_sRVY2oG59U,29963
 scc_firewall_manager_sdk/api/msp_device_health_aggregations_api.py,sha256=uRgrs-XnYApCIYVOd8Hb4nr955EZ6dIUX9YOV2sSBxA,13813
@@ -30,7 +30,7 @@ scc_firewall_manager_sdk/api/search_api.py,sha256=PonVl7RieSVsbCCVQOdqIA7vx2NCH5
 scc_firewall_manager_sdk/api/tenant_management_api.py,sha256=3PWPuirkaUck1VZex3w4Cg3qO05GF0f7xeiptaAc5zE,55069
 scc_firewall_manager_sdk/api/transactions_api.py,sha256=MHHQpikDJuyPAaDcXvLdIWZcpDVFYL8gmk4YkZQbTJE,12470
 scc_firewall_manager_sdk/api/users_api.py,sha256=MKuyXmxWLSqPBkfA7rUGZ1EO1Ox-Oge7QhhgzSFAVu8,191609
-scc_firewall_manager_sdk/models/__init__.py,sha256=X815F4P3A3zFJW0MUtF9Shxtkulf9K2xQL6-GvKnslg,19168
+scc_firewall_manager_sdk/models/__init__.py,sha256=rxs-B6iCptwAYhJNmGA4ezJo1w9rsdba2sDhGdVYBoY,19332
 scc_firewall_manager_sdk/models/access_group.py,sha256=9FlXrDT5xhtk-uWuwgMmM-qAGiKZrpfnkphZuogGsHo,4583
 scc_firewall_manager_sdk/models/access_group_create_input.py,sha256=7tgCifqvqbwS2bZvS_PQdIV_ra_jiEbupJhyaHcG8ys,3930
 scc_firewall_manager_sdk/models/access_group_page.py,sha256=imWa0te5qmTpXfuE8W8YM3SG01MIn4ewbA-_N8kPKHk,3725
@@ -139,6 +139,7 @@ scc_firewall_manager_sdk/models/ftd_deployment_input.py,sha256=3k4T_2km7ZA-OWHMc
 scc_firewall_manager_sdk/models/ftd_ha_info.py,sha256=BASYR0-Yc9tHa31dCnsUYeJ3kvCscUb405iO4AlgdHM,5154
 scc_firewall_manager_sdk/models/ftd_multi_device_deployment_input.py,sha256=GQsJxWF5HQe-CGE_nOSsZP1WqnLHS8Y3ZgOBwACQCic,3839
 scc_firewall_manager_sdk/models/ftd_registration_input.py,sha256=9Gk-1BmP-CSfesXZsAluhsNncoVvZqNh32oh04YZxFc,3191
+scc_firewall_manager_sdk/models/ftd_upgrade_run_dto_page.py,sha256=GxoWx4VQmcKbYfe0ydJ1QuJbVat1wMXMq9A7nO9YM70,3754
 scc_firewall_manager_sdk/models/ftd_version.py,sha256=_vxx9mDA9Yw17QZwKngvSApzxJLw6cP0JDSyCjXgl88,3986
 scc_firewall_manager_sdk/models/ftd_versions_response.py,sha256=Dh45CZJpqPa2YJGkzkrT548JeTU1l4zdohSBnFtFQXQ,3240
 scc_firewall_manager_sdk/models/global_search_result.py,sha256=qZ_9gCPvKfbhy3xtwc32Uk5dKGWzrEQ8o_26IV3LFH0,4227
@@ -251,6 +252,7 @@ scc_firewall_manager_sdk/models/update_request.py,sha256=okwPfBTYcCUw5ZD1-XYOwa-
 scc_firewall_manager_sdk/models/upgrade_asa_device_input.py,sha256=nGZpqNNTLxrRxqVWReVy05J8QtyhM05Fz9ZM1AMusDs,2980
 scc_firewall_manager_sdk/models/upgrade_ftd_device_input.py,sha256=EkZVgn1onpw5ruKOa4ygYjty2VHVWdknM8G0c4r4VZA,3444
 scc_firewall_manager_sdk/models/upgrade_ftd_devices_input.py,sha256=SOs24cfe6PwO9_8yefiwdGioYrIXPKQtU1GRa4IgCqc,3859
+scc_firewall_manager_sdk/models/upgrade_run_dto.py,sha256=Aw4R31JM_NfUrPerNZEPpCq9zntmw5UvCt-xh104piU,5544
 scc_firewall_manager_sdk/models/url_object_content.py,sha256=OqcDbRE_HoEGf4Z_yCsTH8B08R9GdY8RMOs1wM0-ecY,2657
 scc_firewall_manager_sdk/models/user.py,sha256=2bH858kufK8KnTsIXIul0VOH0JpJ-g4zyXE9lyMQHGE,4297
 scc_firewall_manager_sdk/models/user_create_or_update_input.py,sha256=_H5fXo4_Pa5_mIK7T2LzPu_ekMnZlXdxVvsU8Rs612g,3850
@@ -262,7 +264,7 @@ scc_firewall_manager_sdk/models/vlan_interface_create_input.py,sha256=AKUqPJw5ku
 scc_firewall_manager_sdk/models/vlan_interface_patch_input.py,sha256=srEFTyQykscNrWsbp8KGEzbmHC07_AU3DXjJ-7Be4zc,6054
 scc_firewall_manager_sdk/models/ztp_onboarding_input.py,sha256=HAgBTdocZeHGDZP_-9NyRtzP9E7BReGtiOmn4S3J-_g,5326
 scc_firewall_manager_sdk/models/ztp_onboarding_template_configuration.py,sha256=f9Z62yGFvz4QAQ07Z4bjfHLw2bRg46ccwoLuQ8q30TE,4808
-scc_firewall_manager_sdk-1.15.27.dist-info/METADATA,sha256=_WWtmHtfmcIyH-OgBSp-9AL9pL6xE8YGAyY0-lagQ_I,595
-scc_firewall_manager_sdk-1.15.27.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-scc_firewall_manager_sdk-1.15.27.dist-info/top_level.txt,sha256=_g9WfFWGagKs6ULdfhEt8e7RXknpcp9_jA9ubIL4U3I,25
-scc_firewall_manager_sdk-1.15.27.dist-info/RECORD,,
+scc_firewall_manager_sdk-1.15.29.dist-info/METADATA,sha256=Y16muX1lZkBsL_Db7-eFq9NKlStaFsK5OYplX1Q8MWw,595
+scc_firewall_manager_sdk-1.15.29.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+scc_firewall_manager_sdk-1.15.29.dist-info/top_level.txt,sha256=_g9WfFWGagKs6ULdfhEt8e7RXknpcp9_jA9ubIL4U3I,25
+scc_firewall_manager_sdk-1.15.29.dist-info/RECORD,,