scc-firewall-manager-sdk 1.15.44__py3-none-any.whl → 1.15.45__py3-none-any.whl

scc_firewall_manager_sdk/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.15.44"
+__version__ = "1.15.45"
 
 # import apis into sdk package
 from scc_firewall_manager_sdk.api.ai_assistant_api import AIAssistantApi

scc_firewall_manager_sdk/api/transactions_api.py

@@ -38,6 +38,279 @@ class TransactionsApi:
         self.api_client = api_client
 
 
+    @validate_call
+    def cancel_transaction(
+        self,
+        transaction_uid: StrictStr,
+        _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,
+    ) -> CdoTransaction:
+        """Cancel Transaction
+
+        Cancel a running transaction. **Note:**: Only transactions of cancellable types can be cancelled; whether a transaction is cancellable is indicated by the <pre>isCancellable</pre> field in the <pre>CdoTransaction</pre> object.
+
+        :param transaction_uid: (required)
+        :type transaction_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._cancel_transaction_serialize(
+            transaction_uid=transaction_uid,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CdoTransaction",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '422': "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 cancel_transaction_with_http_info(
+        self,
+        transaction_uid: StrictStr,
+        _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[CdoTransaction]:
+        """Cancel Transaction
+
+        Cancel a running transaction. **Note:**: Only transactions of cancellable types can be cancelled; whether a transaction is cancellable is indicated by the <pre>isCancellable</pre> field in the <pre>CdoTransaction</pre> object.
+
+        :param transaction_uid: (required)
+        :type transaction_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._cancel_transaction_serialize(
+            transaction_uid=transaction_uid,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CdoTransaction",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '422': "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 cancel_transaction_without_preload_content(
+        self,
+        transaction_uid: StrictStr,
+        _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:
+        """Cancel Transaction
+
+        Cancel a running transaction. **Note:**: Only transactions of cancellable types can be cancelled; whether a transaction is cancellable is indicated by the <pre>isCancellable</pre> field in the <pre>CdoTransaction</pre> object.
+
+        :param transaction_uid: (required)
+        :type transaction_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._cancel_transaction_serialize(
+            transaction_uid=transaction_uid,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CdoTransaction",
+            '400': "CommonApiError",
+            '401': "AuthenticationError",
+            '403': "CommonApiError",
+            '422': "CommonApiError",
+            '500': "CommonApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _cancel_transaction_serialize(
+        self,
+        transaction_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 transaction_uid is not None:
+            _path_params['transactionUid'] = transaction_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='POST',
+            resource_path='/v1/transactions/{transactionUid}/cancel',
+            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_transaction(
         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.44/python'
+        self.user_agent = 'OpenAPI-Generator/1.15.45/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.44".\
+               "SDK Package Version: 1.15.45".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

scc_firewall_manager_sdk/models/cdo_transaction.py

@@ -19,7 +19,7 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+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
@@ -28,6 +28,7 @@ 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")
@@ -40,7 +41,7 @@ class CdoTransaction(BaseModel):
     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")
-    __properties: ClassVar[List[str]] = ["cdoTransactionStatus", "entityUid", "entityUrl", "errorDetails", "errorMessage", "lastUpdatedTime", "submissionTime", "tenantUid", "transactionDetails", "transactionPollingUrl", "transactionType", "transactionUid"]
+    __properties: ClassVar[List[str]] = ["cancellable", "cdoTransactionStatus", "entityUid", "entityUrl", "errorDetails", "errorMessage", "lastUpdatedTime", "submissionTime", "tenantUid", "transactionDetails", "transactionPollingUrl", "transactionType", "transactionUid"]
 
     @field_validator('cdo_transaction_status')
     def cdo_transaction_status_validate_enum(cls, value):
@@ -48,8 +49,8 @@ class CdoTransaction(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['PENDING', 'IN_PROGRESS', 'DONE', 'ERROR']):
-            raise ValueError("must be one of enum values ('PENDING', 'IN_PROGRESS', 'DONE', 'ERROR')")
+        if value not in set(['PENDING', 'IN_PROGRESS', 'CANCELLED', 'DONE', 'ERROR']):
+            raise ValueError("must be one of enum values ('PENDING', 'IN_PROGRESS', 'CANCELLED', 'DONE', 'ERROR')")
         return value
 
     @field_validator('transaction_type')
@@ -113,6 +114,7 @@ class CdoTransaction(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "cancellable": obj.get("cancellable"),
             "cdoTransactionStatus": obj.get("cdoTransactionStatus"),
             "entityUid": obj.get("entityUid"),
             "entityUrl": obj.get("entityUrl"),

{scc_firewall_manager_sdk-1.15.44.dist-info → scc_firewall_manager_sdk-1.15.45.dist-info}/METADATA

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

{scc_firewall_manager_sdk-1.15.44.dist-info → scc_firewall_manager_sdk-1.15.45.dist-info}/RECORD

@@ -1,7 +1,7 @@
-scc_firewall_manager_sdk/__init__.py,sha256=ZeuusHwl51coYajHKWc-_iyMe3sNqN0toBLdiMSQaPk,21822
-scc_firewall_manager_sdk/api_client.py,sha256=NXz--ykquLaxnefFiqstZ_rSkQRmgl_t9Ssc7AfXoFA,25920
+scc_firewall_manager_sdk/__init__.py,sha256=ChWFjsHwQN3j-_Iv5vVsHu3NNwHa7BaPNzcqW_EuKjw,21822
+scc_firewall_manager_sdk/api_client.py,sha256=gXnop8JvzDiKU1Jgw_Xg4MnIYxe1YvqHYzMsFazWFwY,25920
 scc_firewall_manager_sdk/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-scc_firewall_manager_sdk/configuration.py,sha256=dofv-J0bitAy9YBhOKrDqCm8nAMqjJ4K3XzPK2PqQqs,15992
+scc_firewall_manager_sdk/configuration.py,sha256=GhE9EZgKTD9lzwSsch4rTXyuredTl9hgzhP3xZuVh00,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
@@ -28,7 +28,7 @@ scc_firewall_manager_sdk/api/object_management_api.py,sha256=cblgyzHCSChesXOt3ST
 scc_firewall_manager_sdk/api/remote_access_monitoring_api.py,sha256=1uuvntEP_a5bSCIWNuvr7VcLM8pBiRqkvcb77JeHz8Q,86274
 scc_firewall_manager_sdk/api/search_api.py,sha256=PonVl7RieSVsbCCVQOdqIA7vx2NCH5KPaLJ6XXNcNTQ,22845
 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/transactions_api.py,sha256=fz0Ko2bAXFpz0SM8psceOlcxq0gXnrnuTEhaX1E0QzA,23402
 scc_firewall_manager_sdk/api/users_api.py,sha256=MKuyXmxWLSqPBkfA7rUGZ1EO1Ox-Oge7QhhgzSFAVu8,191609
 scc_firewall_manager_sdk/models/__init__.py,sha256=rxs-B6iCptwAYhJNmGA4ezJo1w9rsdba2sDhGdVYBoY,19332
 scc_firewall_manager_sdk/models/access_group.py,sha256=9FlXrDT5xhtk-uWuwgMmM-qAGiKZrpfnkphZuogGsHo,4583
@@ -74,7 +74,7 @@ scc_firewall_manager_sdk/models/cdo_cli_result_page.py,sha256=EEzs3R4dw2xL_DmFPg
 scc_firewall_manager_sdk/models/cdo_region.py,sha256=fwAiLYKyjGj_dDMLs-_8FPoupimXXltZoVElUoI20OQ,2995
 scc_firewall_manager_sdk/models/cdo_region_list.py,sha256=L3qMHaEdwsOmQ3PVzXs4MpliUwzQOY8It6el0WOGfKc,3059
 scc_firewall_manager_sdk/models/cdo_token_info.py,sha256=74VNvHxM0f0wVpNSB4fwNFvt_Y-50VuwCPjt2g7Y8b0,4547
-scc_firewall_manager_sdk/models/cdo_transaction.py,sha256=LxL-PL90YM-oKP5T-BPnnPQCcP6rgqFXCzQo2p1_3vs,8660
+scc_firewall_manager_sdk/models/cdo_transaction.py,sha256=DG22ltEisBZefzwaBX4oQyHwSI9u9lDLk4NfPTmkUGY,8809
 scc_firewall_manager_sdk/models/change_request.py,sha256=pvjYq818o6W8Fy2_Rt6qMp7jSOFnCqK9goVIWPxENGY,2939
 scc_firewall_manager_sdk/models/change_request_create_input.py,sha256=VEEWpKGhmegCbIYkzhctJPjBpDQgzATuN9zbE2DjRTA,2961
 scc_firewall_manager_sdk/models/change_request_page.py,sha256=8OBeXBlutEbhpLVe1n6hhaVpFzAMX4MPtO8jGLjfS-E,3741
@@ -264,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.44.dist-info/METADATA,sha256=nNuNl97-E9Zq74zs41tBnU1vFCDVnxHOD58oKb75VFU,595
-scc_firewall_manager_sdk-1.15.44.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-scc_firewall_manager_sdk-1.15.44.dist-info/top_level.txt,sha256=_g9WfFWGagKs6ULdfhEt8e7RXknpcp9_jA9ubIL4U3I,25
-scc_firewall_manager_sdk-1.15.44.dist-info/RECORD,,
+scc_firewall_manager_sdk-1.15.45.dist-info/METADATA,sha256=nvmgvNCXO8wbHmiVIMoMC9PUZMhnCXG4e2cnALxV2QI,595
+scc_firewall_manager_sdk-1.15.45.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+scc_firewall_manager_sdk-1.15.45.dist-info/top_level.txt,sha256=_g9WfFWGagKs6ULdfhEt8e7RXknpcp9_jA9ubIL4U3I,25
+scc_firewall_manager_sdk-1.15.45.dist-info/RECORD,,