splunk-soar-sdk 3.7.0__py3-none-any.whl → 3.8.0__py3-none-any.whl

soar_sdk/asset.py

@@ -34,6 +34,7 @@ def AssetField(
     sensitive: bool = False,
     alias: str | None = None,
     category: FieldCategory = FieldCategory.CONNECTIVITY,
+    is_file: bool = False,
 ) -> Any:  # noqa: ANN401
     """Define an asset configuration field with SOAR-specific metadata.
 
@@ -47,6 +48,8 @@ def AssetField(
         sensitive: Marks the field as secret so it is encrypted and hidden from logs.
         alias: Alternate name to emit in the manifest instead of the attribute name.
         category: Grouping used to organize fields in the SOAR UI.
+        is_file: Marks the field as a file upload field. The field must be typed as
+            str and will receive the file contents as a string.
 
     Returns:
         A Pydantic ``Field`` carrying the metadata needed for manifest generation.
@@ -58,6 +61,8 @@ def AssetField(
         json_schema_extra["value_list"] = value_list
     if sensitive is not None:
         json_schema_extra["sensitive"] = sensitive
+    if is_file:
+        json_schema_extra["is_file"] = True
 
     # Use ... for required fields
     field_default: Any = ... if default is None and required else default
@@ -222,6 +227,13 @@ class BaseAsset(BaseModel):
                     )
                 type_name = "password"
 
+            if json_schema_extra.get("is_file", False):
+                if field_type is not str:
+                    raise TypeError(
+                        f"File parameter {field_name} must be type str, not {field_type.__name__}"
+                    )
+                type_name = "file"
+
             if not (description := field.description):
                 description = cls._default_field_description(field_name)
 

{splunk_soar_sdk-3.7.0.dist-info → splunk_soar_sdk-3.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 3.7.0
+Version: 3.8.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-3.7.0.dist-info → splunk_soar_sdk-3.8.0.dist-info}/RECORD

@@ -5,7 +5,7 @@ soar_sdk/actions_manager.py,sha256=8IYOi2k8i9LHXEhQVZ0Ig3IS1gD3iAmOJ9q0bi14g-o,7
 soar_sdk/app.py,sha256=2bUWx1BgWS9Kwkp0aUzVWM8LTdVUq1JI2eXR0LhwEMU,37092
 soar_sdk/app_cli_runner.py,sha256=K1ATWyGs0iNgPfIjMthsN72laOXqXCFZNEXfuzAMOM4,11645
 soar_sdk/app_client.py,sha256=hbe1R2QwXDmoS4959a-ay9oylD1Qk-oPJvJRnxvICz0,6281
-soar_sdk/asset.py,sha256=FI4HHtFdDXcOuad8sXB4ShkTzM8la42sZivCKjJK78o,11596
+soar_sdk/asset.py,sha256=CUCFjUVAawrk3hyGvQn_qNApqJx8J4VxzD--iGEE2pc,12123
 soar_sdk/asset_state.py,sha256=qh4n8IoabVObIZXRPyM0zznwC5LcJpbADcybmDdQABc,2318
 soar_sdk/async_utils.py,sha256=Dz7RagIRjyIagA9vivHWSb18S96J2WOuDB8B5Zy64AE,1428
 soar_sdk/colors.py,sha256=--i_iXqfyITUz4O95HMjfZQGbwFZ34bLmBhtfpXXqlQ,1095
@@ -116,8 +116,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=j3kbvYmcOlcj3gQYKtrv7iS-lDavMKYNLdCNMy_I2Hc,4542
 soar_sdk/webhooks/routing.py,sha256=OjezhuAb8wzW0MnbGSnIWeAH3uJcu-Sb7s3w9zoiPVM,6873
-splunk_soar_sdk-3.7.0.dist-info/METADATA,sha256=etgn77ft4OQs4sPRMdUk88IMtxC7CPQoECTOPmrv9kk,7544
-splunk_soar_sdk-3.7.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-splunk_soar_sdk-3.7.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-3.7.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-3.7.0.dist-info/RECORD,,
+splunk_soar_sdk-3.8.0.dist-info/METADATA,sha256=Sulxm0L7rnkY_17tCaITHItSmYiHA2J26kYLZ2ymxcw,7544
+splunk_soar_sdk-3.8.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+splunk_soar_sdk-3.8.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-3.8.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-3.8.0.dist-info/RECORD,,