splunk-soar-sdk 1.6.3__py3-none-any.whl → 2.0.0__py3-none-any.whl

soar_sdk/action_results.py

@@ -150,19 +150,6 @@ class ActionOutput(BaseModel):
         Nested ActionOutput classes are supported for complex data structures.
     """
 
-    def generate_action_summary_message(self) -> str:
-        """Generate a summary message for the action output.
-
-        This method provides a human-readable summary of the action results,
-        which appears when running the action in a SOAR playbook or container.
-
-        Returns:
-            A string summarizing the action output.
-
-        .. deprecated:: 1.3.0
-        """
-        return "Action completed successfully."
-
     @classmethod
     def _to_json_schema(
         cls, parent_datapath: str = "action_result.data.*"
@@ -237,13 +224,13 @@ class ActionOutput(BaseModel):
             yield schema_field
 
 
-class GenericActionOutput(ActionOutput):
-    """Output class for generic actions.
+class MakeRequestOutput(ActionOutput):
+    """Output class for ``make request`` action.
 
     This class extends the `ActionOutput` class and adds a status_code and response_body field. You can use this class as is or extend it to add more fields.
 
     Example:
-        >>> class CustomGenericActionOutput(GenericActionOutput):
+        >>> class CustomMakeRequestOutput(MakeRequestOutput):
         ...     error: str = OutputField(example_values=["Invalid credentials"])
 
     Note:

soar_sdk/app.py

@@ -12,7 +12,6 @@ from soar_sdk.input_spec import InputSpecification
 from soar_sdk.compat import (
     MIN_PHANTOM_VERSION,
     PythonVersion,
-    remove_when_soar_newer_than,
 )
 from soar_sdk.shims.phantom_common.app_interface.app_interface import SoarRestClient
 from soar_sdk.shims.phantom_common.encryption.encryption_manager_factory import (
@@ -39,7 +38,7 @@ from soar_sdk.decorators import (
     ViewHandlerDecorator,
     OnPollDecorator,
     WebhookDecorator,
-    GenericActionDecorator,
+    MakeRequestDecorator,
 )
 
 
@@ -516,33 +515,33 @@ class App:
         """
         return ViewHandlerDecorator(self, template=template)
 
-    def generic_action(
+    def make_request(
         self, output_class: Optional[type[ActionOutput]] = None
-    ) -> GenericActionDecorator:
-        """Decorator for registering a generic action function.
+    ) -> MakeRequestDecorator:
+        """Decorator for registering a ``make request`` action function.
 
-        This decorator marks a function as the generic action for the app. Generic action is used to call any endpoint of the underlying API service this app implements.
-        Only one generic action is allowed per app. The function you define needs to accept at least one parameter of type `GenericActionParams` and can accept any other parameters you need.
+        This decorator marks a function as the ``make request`` action for the app. ``make request`` is used to call any endpoint of the underlying API service this app implements.
+        Only one ``make request`` action is allowed per app. The function you define needs to accept at least one parameter of type :class:`~soar_sdk.params.MakeRequestParams` and can accept any other parameters you need.
         Other useful parameters to accept are the SOARClient and the asset.
 
         Returns:
-            GenericActionDecorator: A decorator instance that handles generic action registration.
+            MakeRequestActionDecorator: A decorator instance that handles ``make request`` action registration.
 
         Example:
-            >>> @app.generic_action()
+            >>> @app.make_request()
             ... def http_action(
-            ...     self, params: GenericActionParams, asset: Asset
-            ... ) -> GenericActionOutput:
+            ...     self, params: MakeRequestParams, asset: Asset
+            ... ) -> MakeRequestOutput:
             ...     logger.info(f"testing connectivity against {asset.base_url}")
-            ...     return GenericActionOutput(
+            ...     return MakeRequestOutput(
             ...         status_code=200,
             ...         response_body=f"Base url is {asset.base_url}",
             ...     )
 
         Note:
-            The generic action function should return either a GenericActionOutput object or an output class derived from ActionOutput/GenericActionOutput.
+            The ``make request`` action function should return either a :class:`~soar_sdk.action_results.MakeRequestOutput` object or of an output class derived from it.
         """
-        return GenericActionDecorator(self, output_class=output_class)
+        return MakeRequestDecorator(self, output_class=output_class)
 
     @staticmethod
     def _validate_params_class(
@@ -652,11 +651,7 @@ class App:
             param_dict = action_params.dict() if action_params else None
 
             if not message:
-                remove_when_soar_newer_than(
-                    "7.0.0",
-                    'Setting action_result.message in this way was deprecated in SDK 1.3.0. Developers must use SOARClient.set_message instead. We should replace the following method call with a static "Action succeeded" message.',
-                )
-                message = result.generate_action_summary_message()
+                message = "Action completed successfully"
 
             result = ActionResult(
                 status=True,

soar_sdk/cli/manifests/serializers.py

@@ -47,15 +47,7 @@ class OutputsSerializer:
         outputs_class: type[ActionOutput],
         summary_class: Optional[type[ActionOutput]] = None,
     ) -> list[OutputFieldSpecification]:
-        """Serializes the data paths of an ActionOutput class to JSON schema."""
-        if (
-            outputs_class.generate_action_summary_message
-            != ActionOutput.generate_action_summary_message
-        ):
-            logger.warning(
-                f"Overriding ActionOutput.generate_action_summary_message is deprecated. Please call SOARClient.set_message from your action handler instead. [in {outputs_class.__name__}]"
-            )
-
+        """Serializes the data paths of an action to JSON schema."""
         status = OutputFieldSpecification(
             data_path="action_result.status",
             data_type="string",

soar_sdk/decorators/__init__.py

@@ -5,12 +5,12 @@ from .test_connectivity import ConnectivityTestDecorator
 from .view_handler import ViewHandlerDecorator
 from .on_poll import OnPollDecorator
 from .webhook import WebhookDecorator
-from .generic_action import GenericActionDecorator
+from .make_request import MakeRequestDecorator
 
 __all__ = [
     "ActionDecorator",
     "ConnectivityTestDecorator",
-    "GenericActionDecorator",
+    "MakeRequestDecorator",
     "OnPollDecorator",
     "ViewHandlerDecorator",
     "WebhookDecorator",

soar_sdk/decorators/{generic_action.py → make_request.py}

@@ -2,9 +2,9 @@ import inspect
 
 from soar_sdk.abstract import SOARClient
 from soar_sdk.action_results import ActionResult
-from soar_sdk.params import GenericActionParams
+from soar_sdk.params import MakeRequestParams
 from soar_sdk.meta.actions import ActionMeta
-from soar_sdk.action_results import ActionOutput, GenericActionOutput
+from soar_sdk.action_results import ActionOutput, MakeRequestOutput
 from soar_sdk.types import Action, action_protocol
 from soar_sdk.exceptions import ActionFailure
 from soar_sdk.async_utils import run_async_if_needed
@@ -18,8 +18,8 @@ if TYPE_CHECKING:
     from soar_sdk.app import App
 
 
-class GenericActionDecorator:
-    """Class-based decorator for generic action functionality."""
+class MakeRequestDecorator:
+    """Class-based decorator for ``make request`` action functionality."""
 
     def __init__(
         self,
@@ -30,32 +30,32 @@ class GenericActionDecorator:
         self.output_class = output_class
 
     def __call__(self, function: Callable) -> Action:
-        """Decorator for the generic HTTP API action.
+        """Decorator for the ``make request`` HTTP API action.
 
-        The decorated function implements a generic action that can be used to call any endpoint of the underlying API service this app implements.
+        The decorated function implements a ``make request`` action that can be used to call any endpoint of the underlying API service this app implements.
 
         Usage:
-        This decorated function automatically gets all the parameters from the GenericActionParams class and passes them to the function. GenericActionParams represents the parameters required for most http requests.
+        This decorated function automatically gets all the parameters from the :class:`~soar_sdk.params.MakeRequestParams` class and passes them to the function. ``MakeRequestParams`` represents the parameters required for most http requests.
         You should use your existing asset interface to make this request.
         """
-        if self.app.actions_manager.get_action("generic_action"):
+        if self.app.actions_manager.get_action("make_request"):
             raise TypeError(
-                "The 'generic_action' decorator can only be used once per App instance."
+                "The 'make_request' decorator can only be used once per App instance."
             )
 
-        # Validate function signature - must have at least one parameter of type GenericActionParams
+        # Validate function signature - must have at least one parameter of type MakeRequestParams
         signature = inspect.signature(function)
         params = list(signature.parameters.values())
 
-        if not any(param.annotation == GenericActionParams for param in params):
+        if not any(param.annotation == MakeRequestParams for param in params):
             raise TypeError(
-                f"Generic action function must have at least one parameter of type GenericActionParams, got {params[0].annotation}"
+                f"Make request action function must have at least one parameter of type MakeRequestParams, got {params[0].annotation}"
             )
 
-        action_identifier = "generic_action"
-        action_name = "generic action"
-        # for generic action use GenericActionParams
-        validated_params_class = GenericActionParams
+        action_identifier = "make_request"
+        action_name = "make request"
+        # for make request action use MakeRequestParams
+        validated_params_class = MakeRequestParams
 
         return_type = inspect.signature(function).return_annotation
         if return_type is not inspect.Signature.empty:
@@ -68,10 +68,10 @@ class GenericActionDecorator:
             )
 
         if not issubclass(validated_output_class, ActionOutput) and not isinstance(
-            validated_output_class, GenericActionOutput
+            validated_output_class, MakeRequestOutput
         ):
             raise TypeError(
-                "Return type for action function must be either GenericActionOutput or derived from ActionOutput or GenericActionOutput class."
+                "Return type for action function must be either MakeRequestOutput or derived from ActionOutput or MakeRequestOutput class."
             )
 
         logger = getLogger()
@@ -79,7 +79,7 @@ class GenericActionDecorator:
         @action_protocol
         @wraps(function)
         def inner(
-            params: GenericActionParams,
+            params: MakeRequestParams,
             soar: SOARClient = self.app.soar_client,
             *args: Any,  # noqa: ANN401
             **kwargs: Any,  # noqa: ANN401
@@ -122,7 +122,7 @@ class GenericActionDecorator:
             action=action_name,
             identifier=action_identifier,
             description=inspect.getdoc(function) or action_name,
-            verbose="Generic action for the app.",
+            verbose="'make request' action for the app. Used to handle arbitrary HTTP requests with the app's asset",
             type="generic",
             parameters=validated_params_class,
             output=validated_output_class,

soar_sdk/params.py

@@ -170,8 +170,8 @@ class OnPollParams(Params):
     )
 
 
-class GenericActionParams(Params):
-    """Canonical parameters for the special generic HTTP actions."""
+class MakeRequestParams(Params):
+    """Canonical parameters for the special make request action."""
 
     http_method: str = Param(
         description="The HTTP method to use for the request.",

{splunk_soar_sdk-1.6.3.dist-info → splunk_soar_sdk-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 1.6.3
+Version: 2.0.0
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-1.6.3.dist-info → splunk_soar_sdk-2.0.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
 soar_sdk/abstract.py,sha256=jGXs2Fv5TRpnh5Duz3mWjY8_DAOpY4RSSzvw_z4XN4I,7950
-soar_sdk/action_results.py,sha256=4uKVz-oUVJf9idMdTijUD28PdF6ZKNdrpOTkMCRD0Fs,10202
+soar_sdk/action_results.py,sha256=VJaBzXY0CW1Ncvo0E1ospxYi1buGER6JhL2BoQ4Dbwo,9770
 soar_sdk/actions_manager.py,sha256=wJCyfzkI_6OKZ-Kmll4vRJpGvYdL93Uw-JyEEGnKcw0,5779
-soar_sdk/app.py,sha256=KhRpCUtbvF4g6Ecn9iSNv6Su5KMIB1VhfRdGxIPdP8A,32884
+soar_sdk/app.py,sha256=mFzfGTtsCdlrp5Q0amj53s07oXC5Zhy7ym7U0zFPjQs,32580
 soar_sdk/app_cli_runner.py,sha256=fJoozhyAt7QUMuc02nE5RL_InpsjQBpr6U4rF9sey3E,11627
 soar_sdk/app_client.py,sha256=0r3jIvMM8szCEHXOgRu07VaovKH96pZut5rn2GfYcsc,6275
 soar_sdk/asset.py,sha256=deS8_B5hr7W2fED8_6wUpVriRgiQ5r8TkGVHiasIaro,10666
@@ -13,7 +13,7 @@ soar_sdk/crypto.py,sha256=qiBMHUQqgn5lPI1DbujSj700s89FuLJrkQgCO9_eBn4,392
 soar_sdk/exceptions.py,sha256=CxJ_Q6N1jlknO_3ItDQNhHEw2pNWZr3sMLqutYmr5HA,1863
 soar_sdk/input_spec.py,sha256=BAa36l8IKDvM8SVMjgZ1XcnWZ2F7O052n2415tLeKK8,4690
 soar_sdk/logging.py,sha256=lSz8PA6hOCw2MHGE0ZSKbw-FzSr1WdbfQ7BHnXBUUY0,11440
-soar_sdk/params.py,sha256=vUicPw6cdepEbwgg5A2DgIjSSUbhnlOXz_U1jxFH45Q,7491
+soar_sdk/params.py,sha256=8wo6buia91Hh-bxq0jVUU9MPN3XZVRzkMfKZ2BDuMLQ,7488
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -38,7 +38,7 @@ soar_sdk/cli/manifests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 soar_sdk/cli/manifests/cli.py,sha256=cly5xVdj4bBIdZVMQPIWTXRgUfd1ON3qKO-76Fwql18,524
 soar_sdk/cli/manifests/deserializers.py,sha256=FtXv-OywYGb_O5TptS2Hg6niWcfihRPF_RaS5zDBXRk,17045
 soar_sdk/cli/manifests/processors.py,sha256=6B1fQC2WGVaUP-7E9Y5g7BipaVwEomJCkUQ_7gRfSn8,4155
-soar_sdk/cli/manifests/serializers.py,sha256=HA7a3DSzB3P-v2yomAMZW0M1__wY2yCNLU_v0QZv7Vo,3245
+soar_sdk/cli/manifests/serializers.py,sha256=tlW8QPuaVUF8u384lN02xIK2bS2XkDL52kPNwwPmj9c,2859
 soar_sdk/cli/package/cli.py,sha256=oCpP9E3PtXq-zCdzQD8Z-4dowKF1YT-uKjTpbt_YT-A,9516
 soar_sdk/cli/package/utils.py,sha256=NQgMxWZSf20hqd4Orov77b7qK23QAO3zIEvRTj9HW-o,1590
 soar_sdk/code_renderers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -48,9 +48,9 @@ soar_sdk/code_renderers/asset_renderer.py,sha256=f2e2jC43nD0S_bOOfABs-e6Okcyn8zn
 soar_sdk/code_renderers/renderer.py,sha256=oDlmU-MzDqpc4Yq6zupoT4XN-vRjgL4UV5lOGTLeqkg,1242
 soar_sdk/code_renderers/toml_renderer.py,sha256=-zP8UzlYMCVVA5ex9slaNLeFTu4xLjkv88YLmRNLrTM,1505
 soar_sdk/code_renderers/templates/pyproject.toml.jinja,sha256=Ti6A5kWMb902Lbd1kmw8qPgVDPNNzlV6rd0pcVEbVUo,3917
-soar_sdk/decorators/__init__.py,sha256=s1DOPbNgFN4AHUgMQeYQ4AkbK_BAA3HJaKMjW5RDq84,519
+soar_sdk/decorators/__init__.py,sha256=ttvapTczeQpReZVYgjTw4qnEqKd7b8pR7lNaCpO0npQ,513
 soar_sdk/decorators/action.py,sha256=7S43XFl0WBa9BYOpyFhlSmxT-08DvV1VQ4P5nEMw8ms,6128
-soar_sdk/decorators/generic_action.py,sha256=QxKWdr9SXYNWcgIlHrnenasJE0AI4Y8Q0em10ScPTPI,5429
+soar_sdk/decorators/make_request.py,sha256=W_ltGvryTvdKomiJ8gL7rE_KVc1VVodhFYstGxB8d4Q,5527
 soar_sdk/decorators/on_poll.py,sha256=xdT0QSa_dnh37XdJNGW-DAZsb9oQO5tjxPbIQmWpaZs,8232
 soar_sdk/decorators/test_connectivity.py,sha256=8uXMD4NW5bokpsAfBctUrfOR4K_geYLEZUY0Y6uI6aU,3568
 soar_sdk/decorators/view_handler.py,sha256=jhBzbJcokWOeUWR4_orDRWTXiiVwE9RZdRSvNUYF3S0,7362
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-1.6.3.dist-info/METADATA,sha256=0_WxMtlZ3BrXjEpcCJ5Yg8nVkQi4gfv9ProOkQPr1mw,7361
-splunk_soar_sdk-1.6.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-1.6.3.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-1.6.3.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-1.6.3.dist-info/RECORD,,
+splunk_soar_sdk-2.0.0.dist-info/METADATA,sha256=GiFXmEsBHTw7YBcnk8OV5U48usWYNpd-djWhMy_eeiI,7361
+splunk_soar_sdk-2.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.0.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.0.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.0.0.dist-info/RECORD,,