scc-firewall-manager-sdk 1.15.358__py3-none-any.whl → 1.15.389__py3-none-any.whl

scc_firewall_manager_sdk/api/interface_health_aggregations_api.py

@@ -49,7 +49,7 @@ class InterfaceHealthAggregationsApi:
         threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
         aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
         managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
-        q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -75,7 +75,7 @@ class InterfaceHealthAggregationsApi:
         :type aggregation_period: str
         :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
         :type managed_tenant_uid: str
-        :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
+        :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
         :type q: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -137,7 +137,7 @@ class InterfaceHealthAggregationsApi:
         threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
         aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
         managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
-        q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -163,7 +163,7 @@ class InterfaceHealthAggregationsApi:
         :type aggregation_period: str
         :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
         :type managed_tenant_uid: str
-        :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
+        :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
         :type q: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -225,7 +225,7 @@ class InterfaceHealthAggregationsApi:
         threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
         aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
         managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
-        q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -251,7 +251,7 @@ class InterfaceHealthAggregationsApi:
         :type aggregation_period: str
         :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
         :type managed_tenant_uid: str
-        :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
+        :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
         :type q: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

scc_firewall_manager_sdk/api/msp_device_upgrades_api.py

@@ -22,6 +22,7 @@ from typing import List, Optional
 from typing_extensions import Annotated
 from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
 from scc_firewall_manager_sdk.models.msp_calculate_compatible_upgrade_versions_input import MspCalculateCompatibleUpgradeVersionsInput
+from scc_firewall_manager_sdk.models.msp_upgrade_ftd_devices_input import MspUpgradeFtdDevicesInput
 from scc_firewall_manager_sdk.models.msp_upgrade_run_dto import MspUpgradeRunDto
 from scc_firewall_manager_sdk.models.msp_upgrade_run_dto_page import MspUpgradeRunDtoPage
 from scc_firewall_manager_sdk.models.msp_upgrade_runs_attribute_values import MspUpgradeRunsAttributeValues
@@ -1696,6 +1697,7 @@ class MSPDeviceUpgradesApi:
     @validate_call
     def upgrade_msp_managed_ftd_devices(
         self,
+        msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1713,6 +1715,8 @@ class MSPDeviceUpgradesApi:
 
         <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>
 
+        :param msp_upgrade_ftd_devices_input: (required)
+        :type msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput
         :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
@@ -1736,6 +1740,7 @@ class MSPDeviceUpgradesApi:
         """ # noqa: E501
 
         _param = self._upgrade_msp_managed_ftd_devices_serialize(
+            msp_upgrade_ftd_devices_input=msp_upgrade_ftd_devices_input,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1760,6 +1765,7 @@ class MSPDeviceUpgradesApi:
     @validate_call
     def upgrade_msp_managed_ftd_devices_with_http_info(
         self,
+        msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1777,6 +1783,8 @@ class MSPDeviceUpgradesApi:
 
         <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>
 
+        :param msp_upgrade_ftd_devices_input: (required)
+        :type msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput
         :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
@@ -1800,6 +1808,7 @@ class MSPDeviceUpgradesApi:
         """ # noqa: E501
 
         _param = self._upgrade_msp_managed_ftd_devices_serialize(
+            msp_upgrade_ftd_devices_input=msp_upgrade_ftd_devices_input,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1824,6 +1833,7 @@ class MSPDeviceUpgradesApi:
     @validate_call
     def upgrade_msp_managed_ftd_devices_without_preload_content(
         self,
+        msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1841,6 +1851,8 @@ class MSPDeviceUpgradesApi:
 
         <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>
 
+        :param msp_upgrade_ftd_devices_input: (required)
+        :type msp_upgrade_ftd_devices_input: MspUpgradeFtdDevicesInput
         :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
@@ -1864,6 +1876,7 @@ class MSPDeviceUpgradesApi:
         """ # noqa: E501
 
         _param = self._upgrade_msp_managed_ftd_devices_serialize(
+            msp_upgrade_ftd_devices_input=msp_upgrade_ftd_devices_input,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1883,6 +1896,7 @@ class MSPDeviceUpgradesApi:
 
     def _upgrade_msp_managed_ftd_devices_serialize(
         self,
+        msp_upgrade_ftd_devices_input,
         _request_auth,
         _content_type,
         _headers,
@@ -1906,6 +1920,8 @@ class MSPDeviceUpgradesApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
+        if msp_upgrade_ftd_devices_input is not None:
+            _body_params = msp_upgrade_ftd_devices_input
 
 
         # set the HTTP header `Accept`
@@ -1915,6 +1931,19 @@ class MSPDeviceUpgradesApi:
             ]
         )
 
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
 
         # authentication setting
         _auth_settings: List[str] = [

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.358/python'
+        self.user_agent = 'OpenAPI-Generator/1.15.389/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.358".\
+               "SDK Package Version: 1.15.389".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

scc_firewall_manager_sdk/models/__init__.py

@@ -76,6 +76,7 @@ from scc_firewall_manager_sdk.models.command_response import CommandResponse
 from scc_firewall_manager_sdk.models.common_api_error import CommonApiError
 from scc_firewall_manager_sdk.models.compatible_device_dto import CompatibleDeviceDto
 from scc_firewall_manager_sdk.models.compatible_version_info_dto import CompatibleVersionInfoDto
+from scc_firewall_manager_sdk.models.completion_status_dto import CompletionStatusDto
 from scc_firewall_manager_sdk.models.config_state import ConfigState
 from scc_firewall_manager_sdk.models.conflict_detection_interval import ConflictDetectionInterval
 from scc_firewall_manager_sdk.models.conflict_detection_state import ConflictDetectionState
@@ -190,6 +191,7 @@ from scc_firewall_manager_sdk.models.msp_managed_template_distinct_attribute_val
 from scc_firewall_manager_sdk.models.msp_managed_templates_page import MspManagedTemplatesPage
 from scc_firewall_manager_sdk.models.msp_managed_tenant import MspManagedTenant
 from scc_firewall_manager_sdk.models.msp_managed_tenant_page import MspManagedTenantPage
+from scc_firewall_manager_sdk.models.msp_upgrade_ftd_devices_input import MspUpgradeFtdDevicesInput
 from scc_firewall_manager_sdk.models.msp_upgrade_run_dto import MspUpgradeRunDto
 from scc_firewall_manager_sdk.models.msp_upgrade_run_dto_page import MspUpgradeRunDtoPage
 from scc_firewall_manager_sdk.models.msp_upgrade_runs_attribute_values import MspUpgradeRunsAttributeValues

scc_firewall_manager_sdk/models/cdo_transaction.py

@@ -29,18 +29,18 @@ class CdoTransaction(BaseModel):
     CdoTransaction
     """ # noqa: E501
     cancellable: Optional[StrictBool] = None
-    cdo_transaction_status: Optional[StrictStr] = Field(default=None, description="The status of the transaction", alias="cdoTransactionStatus")
-    entity_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the entity that the transaction is triggered on. This can be empty, for a transaction that is not tied to an entity, such as transactions which refresh RA VPN sessions.", alias="entityUid")
-    entity_url: Optional[StrictStr] = Field(default=None, description="A URL to access the entity that the transaction is triggered on. This can also be empty", alias="entityUrl")
-    error_details: Optional[Dict[str, StrictStr]] = Field(default=None, description="Transaction error details, if any", alias="errorDetails")
-    error_message: Optional[StrictStr] = Field(default=None, description="Transaction error message, if any", alias="errorMessage")
-    last_updated_time: Optional[datetime] = Field(default=None, description="The time (UTC; represented using the RFC-3339 standard) at which the transaction status was last updated", alias="lastUpdatedTime")
-    submission_time: Optional[datetime] = Field(default=None, description="The time (UTC; represented using the RFC-3339 standard) at which the transaction was triggered", alias="submissionTime")
-    tenant_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the tenant that the transaction triggered on.", alias="tenantUid")
-    transaction_details: Optional[Dict[str, StrictStr]] = Field(default=None, description="Transaction details, if any", alias="transactionDetails")
-    transaction_polling_url: Optional[StrictStr] = Field(default=None, description="The URL to poll to track the progress of the transaction.", alias="transactionPollingUrl")
-    transaction_type: Optional[StrictStr] = Field(default=None, description="the type of the transaction", alias="transactionType")
-    transaction_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the transaction triggered.", alias="transactionUid")
+    cdo_transaction_status: Optional[StrictStr] = Field(default=None, description="Status of the transaction.", alias="cdoTransactionStatus")
+    entity_uid: Optional[StrictStr] = Field(default=None, description="Unique identifier of the entity that the transaction is triggered on. This can be empty, for a transaction that is not tied to an entity, such as transactions which refresh RA VPN sessions.", alias="entityUid")
+    entity_url: Optional[StrictStr] = Field(default=None, description="URL to access the entity that the transaction is triggered on. This can also be empty if not applicable.", alias="entityUrl")
+    error_details: Optional[Dict[str, StrictStr]] = Field(default=None, description="Transaction error details, if any.", alias="errorDetails")
+    error_message: Optional[StrictStr] = Field(default=None, description="Transaction error message, if any.", alias="errorMessage")
+    last_updated_time: Optional[datetime] = Field(default=None, description="Time (UTC; represented using the RFC-3339 standard) at which the transaction status was last updated.", alias="lastUpdatedTime")
+    submission_time: Optional[datetime] = Field(default=None, description="Time (UTC; represented using the RFC-3339 standard) at which the transaction was triggered.", alias="submissionTime")
+    tenant_uid: Optional[StrictStr] = Field(default=None, description="Unique identifier of the tenant that the transaction was triggered on.", alias="tenantUid")
+    transaction_details: Optional[Dict[str, StrictStr]] = Field(default=None, description="Transaction details, if any.", alias="transactionDetails")
+    transaction_polling_url: Optional[StrictStr] = Field(default=None, description="Polling URL to track the progress of the transaction.", alias="transactionPollingUrl")
+    transaction_type: Optional[StrictStr] = Field(default=None, description="Type of the transaction.", alias="transactionType")
+    transaction_uid: Optional[StrictStr] = Field(default=None, description="Unique identifier of the transaction triggered.", alias="transactionUid")
     __properties: ClassVar[List[str]] = ["cancellable", "cdoTransactionStatus", "entityUid", "entityUrl", "errorDetails", "errorMessage", "lastUpdatedTime", "submissionTime", "tenantUid", "transactionDetails", "transactionPollingUrl", "transactionType", "transactionUid"]
 
     @field_validator('cdo_transaction_status')

scc_firewall_manager_sdk/models/completion_status_dto.py

@@ -0,0 +1,104 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CompletionStatusDto(BaseModel):
+    """
+    CompletionStatusDto
+    """ # noqa: E501
+    message: Optional[StrictStr] = Field(default=None, description="A message, indicating current progress, returned from the device.")
+    name: Optional[StrictStr] = Field(default=None, description="The name of the device. Note: this will be the name of the node on the cdFMC if the device is part of an HA pair or cluster.")
+    node_type: Optional[StrictStr] = Field(default=None, description="(HA Pairs and clusters only) The node type of the device.", alias="nodeType")
+    percentage_complete: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The percentage completion of the current task being performed", alias="percentageComplete")
+    __properties: ClassVar[List[str]] = ["message", "name", "nodeType", "percentageComplete"]
+
+    @field_validator('node_type')
+    def node_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['HA_PRIMARY', 'HA_SECONDARY', 'CLUSTER_CONTROL', 'CLUSTER_DATA']):
+            raise ValueError("must be one of enum values ('HA_PRIMARY', 'HA_SECONDARY', 'CLUSTER_CONTROL', 'CLUSTER_DATA')")
+        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 CompletionStatusDto 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 CompletionStatusDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": obj.get("message"),
+            "name": obj.get("name"),
+            "nodeType": obj.get("nodeType"),
+            "percentageComplete": obj.get("percentageComplete")
+        })
+        return _obj
+
+

scc_firewall_manager_sdk/models/device_upgrade_status_dto.py

@@ -18,8 +18,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional, Union
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from scc_firewall_manager_sdk.models.completion_status_dto import CompletionStatusDto
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,28 +28,9 @@ class DeviceUpgradeStatusDto(BaseModel):
     """
     DeviceUpgradeStatusDto
     """ # noqa: E501
-    hardware_model: Optional[StrictStr] = Field(default=None, description="The hardware model of the devices being upgraded.", alias="hardwareModel")
-    managed_tenant_display_name: Optional[StrictStr] = Field(default=None, description="The display name of the managed tenant in CDO.", alias="managedTenantDisplayName")
-    managed_tenant_name: Optional[StrictStr] = Field(default=None, description="The name of the managed tenant in CDO.", alias="managedTenantName")
-    managed_tenant_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the managed tenant in Security Cloud Control that this device belongs to.", alias="managedTenantUid")
-    message: Optional[StrictStr] = Field(default=None, description="A message, indicating current progress, returned from the device.")
-    name: Optional[StrictStr] = Field(default=None, description="The name of the device being upgraded.")
-    percentage_complete: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The percentage completion of the current task being performed", alias="percentageComplete")
-    software_version_before_upgrade: Optional[StrictStr] = Field(default=None, description="The software version of the device before the upgrade.", alias="softwareVersionBeforeUpgrade")
-    transaction_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the CDO transaction on the managed tenant that tracks this upgrade run.", alias="transactionUid")
-    uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the device being upgraded.")
-    upgrade_run_status: Optional[StrictStr] = Field(default=None, description="The current status of the upgrade run.", alias="upgradeRunStatus")
-    __properties: ClassVar[List[str]] = ["hardwareModel", "managedTenantDisplayName", "managedTenantName", "managedTenantUid", "message", "name", "percentageComplete", "softwareVersionBeforeUpgrade", "transactionUid", "uid", "upgradeRunStatus"]
-
-    @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(['IN_PROGRESS', 'REBUILDING_UPGRADE_CACHE', 'PERFORMING_UPGRADE', 'UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UPGRADE_STAGING_FAILED', 'UGPRADE_STAGING_FAILED', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED']):
-            raise ValueError("must be one of enum values ('IN_PROGRESS', 'REBUILDING_UPGRADE_CACHE', 'PERFORMING_UPGRADE', 'UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UPGRADE_STAGING_FAILED', 'UGPRADE_STAGING_FAILED', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED')")
-        return value
+    completion_statuses: Optional[List[CompletionStatusDto]] = Field(default=None, description="The completion status of the upgrade on the device. For HA pairs or clusters, there will be multiple completion statuses; one per node of the pair or cluster.", alias="completionStatuses")
+    uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the device in SCC Firewall Manager.")
+    __properties: ClassVar[List[str]] = ["completionStatuses", "uid"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,6 +71,13 @@ class DeviceUpgradeStatusDto(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in completion_statuses (list)
+        _items = []
+        if self.completion_statuses:
+            for _item in self.completion_statuses:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['completionStatuses'] = _items
         return _dict
 
     @classmethod
@@ -101,17 +90,8 @@ class DeviceUpgradeStatusDto(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "hardwareModel": obj.get("hardwareModel"),
-            "managedTenantDisplayName": obj.get("managedTenantDisplayName"),
-            "managedTenantName": obj.get("managedTenantName"),
-            "managedTenantUid": obj.get("managedTenantUid"),
-            "message": obj.get("message"),
-            "name": obj.get("name"),
-            "percentageComplete": obj.get("percentageComplete"),
-            "softwareVersionBeforeUpgrade": obj.get("softwareVersionBeforeUpgrade"),
-            "transactionUid": obj.get("transactionUid"),
-            "uid": obj.get("uid"),
-            "upgradeRunStatus": obj.get("upgradeRunStatus")
+            "completionStatuses": [CompletionStatusDto.from_dict(_item) for _item in obj["completionStatuses"]] if obj.get("completionStatuses") is not None else None,
+            "uid": obj.get("uid")
         })
         return _obj
 

scc_firewall_manager_sdk/models/msp_upgrade_ftd_devices_input.py

@@ -0,0 +1,97 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MspUpgradeFtdDevicesInput(BaseModel):
+    """
+    MspUpgradeFtdDevicesInput
+    """ # noqa: E501
+    device_uids: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Set of device unique identifiers (UUIDs) to upgrade in Security Cloud Control. All of the devices have to be managed by the MSSP portal, be of type CDFMC_MANAGED_FTD, have the connectivity state ONLINE, and be compatible with the software version specified.", alias="deviceUids")
+    ignore_maintenance_window: Optional[StrictBool] = Field(default=None, description="A boolean value, indicating whether devices maintenance window should be ignored. If this is set to true, upgrade will be allowed even if there are devices outside their maintenance window.", alias="ignoreMaintenanceWindow")
+    name: Optional[StrictStr] = Field(default=None, description="Specify a human-readable name for the upgrade run.")
+    software_version: Optional[StrictStr] = Field(default=None, description="Specify the software version to which all devices will be upgraded.", alias="softwareVersion")
+    stage_upgrade_only: Optional[StrictBool] = Field(default=False, description="A boolean value, indicating whether the upgrade should be staged. If set to true, the image will be downloaded onto the devices and readiness checks will be performed. However, the upgrade will not be applied to the devices.", alias="stageUpgradeOnly")
+    __properties: ClassVar[List[str]] = ["deviceUids", "ignoreMaintenanceWindow", "name", "softwareVersion", "stageUpgradeOnly"]
+
+    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 MspUpgradeFtdDevicesInput 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 MspUpgradeFtdDevicesInput 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"),
+            "ignoreMaintenanceWindow": obj.get("ignoreMaintenanceWindow"),
+            "name": obj.get("name"),
+            "softwareVersion": obj.get("softwareVersion"),
+            "stageUpgradeOnly": obj.get("stageUpgradeOnly") if obj.get("stageUpgradeOnly") is not None else False
+        })
+        return _obj
+
+

scc_firewall_manager_sdk/models/msp_upgrade_runs_attribute_values.py

@@ -28,7 +28,9 @@ class MspUpgradeRunsAttributeValues(BaseModel):
     MspUpgradeRunsAttributeValues
     """ # noqa: E501
     upgrade_run_statuses: Optional[List[StrictStr]] = Field(default=None, description="The distinct status values for the MSP upgrade runs on this MSP portal.", alias="upgradeRunStatuses")
-    __properties: ClassVar[List[str]] = ["upgradeRunStatuses"]
+    upgrade_run_types: Optional[List[StrictStr]] = Field(default=None, alias="upgradeRunTypes")
+    users: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["upgradeRunStatuses", "upgradeRunTypes", "users"]
 
     @field_validator('upgrade_run_statuses')
     def upgrade_run_statuses_validate_enum(cls, value):
@@ -41,6 +43,17 @@ class MspUpgradeRunsAttributeValues(BaseModel):
                 raise ValueError("each list item must be one of ('IN_PROGRESS', 'REBUILDING_UPGRADE_CACHE', 'PERFORMING_UPGRADE', 'UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UPGRADE_STAGING_FAILED', 'UGPRADE_STAGING_FAILED', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED')")
         return value
 
+    @field_validator('upgrade_run_types')
+    def upgrade_run_types_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['ASA_DEVICE_UPGRADE', 'FTD_DEVICE_UPGRADE', 'FTD_SECURE_CLIENT_UPGRADE', 'ASA_SECURE_CLIENT_UPGRADE']):
+                raise ValueError("each list item must be one of ('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,
@@ -92,7 +105,9 @@ class MspUpgradeRunsAttributeValues(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "upgradeRunStatuses": obj.get("upgradeRunStatuses")
+            "upgradeRunStatuses": obj.get("upgradeRunStatuses"),
+            "upgradeRunTypes": obj.get("upgradeRunTypes"),
+            "users": obj.get("users")
         })
         return _obj
 

{scc_firewall_manager_sdk-1.15.358.dist-info → scc_firewall_manager_sdk-1.15.389.dist-info}/METADATA

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