synqly 2.0.87__tar.gz → 2.0.89__tar.gz

{synqly-2.0.87 → synqly-2.0.89}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synqly
-Version: 2.0.87
+Version: 2.0.89
 Summary: SDK for Synqly APIs
 Requires-Python: >=3.7,<4.0
 Classifier: Programming Language :: Python :: 3

{synqly-2.0.87 → synqly-2.0.89}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "synqly"
-version = "2.0.87"
+version = "2.0.89"
 description = "SDK for Synqly APIs"
 readme = "README.md"
 authors = []

{synqly-2.0.87 → synqly-2.0.89}/src/synqly/engine/__init__.py

@@ -33,6 +33,7 @@ if typing.TYPE_CHECKING:
         securityawareness,
         siem,
         sink,
+        ssf,
         stix,
         storage,
         threatintel,
@@ -374,6 +375,7 @@ if typing.TYPE_CHECKING:
         QuerySiemEventsResponse,
     )
     from .sink import CreateSinkEventsResponse
+    from .ssf import CreateSsfEventResponse, GetSsfTransmitterUrlsResponse, SsfEventResult, SsfTransmitterUrls
     from .storage import ListStorageResponse, StoragePath
     from .threatintel import (
         ThreatIntelLookupDomainResponse,
@@ -541,6 +543,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CreateSinkEventsResponse": ".sink",
     "CreateSoftwareInventoryRequest": ".assets",
     "CreateSoftwareInventoryResponse": ".assets",
+    "CreateSsfEventResponse": ".ssf",
     "CreateThreatNoteRequest": ".edr",
     "CreateThreatNoteResponse": ".edr",
     "CreateTicketRequest": ".ticketing",
@@ -634,6 +637,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "GetScanActivitiesResponse": ".vulnerabilities",
     "GetScanActivityResponse": ".vulnerabilities",
     "GetScanStatusResponse": ".vulnerabilities",
+    "GetSsfTransmitterUrlsResponse": ".ssf",
     "GetThreatNotesResponse": ".edr",
     "GetTicketResponse": ".ticketing",
     "GetUserResponse": ".identity",
@@ -824,6 +828,8 @@ _dynamic_imports: typing.Dict[str, str] = {
     "SecurityFinding": ".vulnerabilities",
     "ServiceUnavailableError": ".common",
     "SoftwareInventory": ".assets",
+    "SsfEventResult": ".ssf",
+    "SsfTransmitterUrls": ".ssf",
     "Status": ".ticketing",
     "StoragePath": ".storage",
     "SynqlyEngine": ".client",
@@ -881,6 +887,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "securityawareness": ".securityawareness",
     "siem": ".siem",
     "sink": ".sink",
+    "ssf": ".ssf",
     "stix": ".stix",
     "storage": ".storage",
     "threatintel": ".threatintel",
@@ -986,6 +993,7 @@ __all__ = [
     "CreateSinkEventsResponse",
     "CreateSoftwareInventoryRequest",
     "CreateSoftwareInventoryResponse",
+    "CreateSsfEventResponse",
     "CreateThreatNoteRequest",
     "CreateThreatNoteResponse",
     "CreateTicketRequest",
@@ -1079,6 +1087,7 @@ __all__ = [
     "GetScanActivitiesResponse",
     "GetScanActivityResponse",
     "GetScanStatusResponse",
+    "GetSsfTransmitterUrlsResponse",
     "GetThreatNotesResponse",
     "GetTicketResponse",
     "GetUserResponse",
@@ -1269,6 +1278,8 @@ __all__ = [
     "SecurityFinding",
     "ServiceUnavailableError",
     "SoftwareInventory",
+    "SsfEventResult",
+    "SsfTransmitterUrls",
     "Status",
     "StoragePath",
     "SynqlyEngine",
@@ -1326,6 +1337,7 @@ __all__ = [
     "securityawareness",
     "siem",
     "sink",
+    "ssf",
     "stix",
     "storage",
     "threatintel",

{synqly-2.0.87 → synqly-2.0.89}/src/synqly/engine/client.py

@@ -29,6 +29,7 @@ if typing.TYPE_CHECKING:
     from .securityawareness.client import AsyncSecurityawarenessClient, SecurityawarenessClient
     from .siem.client import AsyncSiemClient, SiemClient
     from .sink.client import AsyncSinkClient, SinkClient
+    from .ssf.client import AsyncSsfClient, SsfClient
     from .storage.client import AsyncStorageClient, StorageClient
     from .threatintel.client import AsyncThreatintelClient, ThreatintelClient
     from .ticketing.client import AsyncTicketingClient, TicketingClient
@@ -140,6 +141,7 @@ class SynqlyEngine:
         self._securityawareness: typing.Optional[SecurityawarenessClient] = None
         self._siem: typing.Optional[SiemClient] = None
         self._sink: typing.Optional[SinkClient] = None
+        self._ssf: typing.Optional[SsfClient] = None
         self._storage: typing.Optional[StorageClient] = None
         self._threatintel: typing.Optional[ThreatintelClient] = None
         self._ticketing: typing.Optional[TicketingClient] = None
@@ -297,6 +299,14 @@ class SynqlyEngine:
             self._sink = SinkClient(client_wrapper=self._client_wrapper)
         return self._sink
 
+    @property
+    def ssf(self):
+        if self._ssf is None:
+            from .ssf.client import SsfClient  # noqa: E402
+
+            self._ssf = SsfClient(client_wrapper=self._client_wrapper)
+        return self._ssf
+
     @property
     def storage(self):
         if self._storage is None:
@@ -456,6 +466,7 @@ class AsyncSynqlyEngine:
         self._securityawareness: typing.Optional[AsyncSecurityawarenessClient] = None
         self._siem: typing.Optional[AsyncSiemClient] = None
         self._sink: typing.Optional[AsyncSinkClient] = None
+        self._ssf: typing.Optional[AsyncSsfClient] = None
         self._storage: typing.Optional[AsyncStorageClient] = None
         self._threatintel: typing.Optional[AsyncThreatintelClient] = None
         self._ticketing: typing.Optional[AsyncTicketingClient] = None
@@ -613,6 +624,14 @@ class AsyncSynqlyEngine:
             self._sink = AsyncSinkClient(client_wrapper=self._client_wrapper)
         return self._sink
 
+    @property
+    def ssf(self):
+        if self._ssf is None:
+            from .ssf.client import AsyncSsfClient  # noqa: E402
+
+            self._ssf = AsyncSsfClient(client_wrapper=self._client_wrapper)
+        return self._ssf
+
     @property
     def storage(self):
         if self._storage is None:

{synqly-2.0.87 → synqly-2.0.89}/src/synqly/engine/core/client_wrapper.py

@@ -39,7 +39,7 @@ class BaseClientWrapper:
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
-        headers["User-Agent"] = "Synqly-Python-SDK/2.0.87"
+        headers["User-Agent"] = "Synqly-Python-SDK/2.0.89"
         return headers
 
     def _get_token(self) -> str:
@@ -142,5 +142,5 @@ class AsyncClientWrapper(BaseClientWrapper):
         if self._async_token is not None:
             token = await self._async_token()
             headers["Authorization"] = f"Bearer {token}"
-        headers["User-Agent"] = "Synqly-Python-SDK/2.0.87"
+        headers["User-Agent"] = "Synqly-Python-SDK/2.0.89"
         return headers

{synqly-2.0.87 → synqly-2.0.89}/src/synqly/engine/operation_id_generated/types/operation_id.py

@@ -127,6 +127,9 @@ class OperationId(enum.StrEnum):
     SIEM_QUERY_INVESTIGATIONS = "siem_query_investigations"
     SIEM_QUERY_LOG_PROVIDERS = "siem_query_log_providers"
     SINK_POST_EVENTS = "sink_post_events"
+    SSF_GET_TRANSMITTER_URLS = "ssf_get_transmitter_urls"
+    SSF_JWKS = "ssf_jwks"
+    SSF_POST_EVENT = "ssf_post_event"
     STORAGE_DELETE_FILE = "storage_delete_file"
     STORAGE_DOWNLOAD_FILE = "storage_download_file"
     STORAGE_LIST_FILES = "storage_list_files"
@@ -299,6 +302,9 @@ class OperationId(enum.StrEnum):
         siem_query_investigations: typing.Callable[[], T_Result],
         siem_query_log_providers: typing.Callable[[], T_Result],
         sink_post_events: typing.Callable[[], T_Result],
+        ssf_get_transmitter_urls: typing.Callable[[], T_Result],
+        ssf_jwks: typing.Callable[[], T_Result],
+        ssf_post_event: typing.Callable[[], T_Result],
         storage_delete_file: typing.Callable[[], T_Result],
         storage_download_file: typing.Callable[[], T_Result],
         storage_list_files: typing.Callable[[], T_Result],
@@ -579,6 +585,12 @@ class OperationId(enum.StrEnum):
             return siem_query_log_providers()
         if self is OperationId.SINK_POST_EVENTS:
             return sink_post_events()
+        if self is OperationId.SSF_GET_TRANSMITTER_URLS:
+            return ssf_get_transmitter_urls()
+        if self is OperationId.SSF_JWKS:
+            return ssf_jwks()
+        if self is OperationId.SSF_POST_EVENT:
+            return ssf_post_event()
         if self is OperationId.STORAGE_DELETE_FILE:
             return storage_delete_file()
         if self is OperationId.STORAGE_DOWNLOAD_FILE:

synqly-2.0.89/src/synqly/engine/ssf/__init__.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import CreateSsfEventResponse, GetSsfTransmitterUrlsResponse, SsfEventResult, SsfTransmitterUrls
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateSsfEventResponse": ".types",
+    "GetSsfTransmitterUrlsResponse": ".types",
+    "SsfEventResult": ".types",
+    "SsfTransmitterUrls": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["CreateSsfEventResponse", "GetSsfTransmitterUrlsResponse", "SsfEventResult", "SsfTransmitterUrls"]

synqly-2.0.89/src/synqly/engine/ssf/client.py

@@ -0,0 +1,146 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawSsfClient, RawSsfClient
+from .types.create_ssf_event_response import CreateSsfEventResponse
+from .types.get_ssf_transmitter_urls_response import GetSsfTransmitterUrlsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SsfClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSsfClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSsfClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSsfClient
+        """
+        return self._raw_client
+
+    def post_event(
+        self,
+        *,
+        request: typing.Any,
+        meta: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateSsfEventResponse:
+        """
+        Signs a security signal as a Security Event Token and delivers it to the receiver configured with the token used for authentication. A success response means the receiver accepted the token. It does not mean the receiver acted on it.
+
+        Parameters
+        ----------
+        request : typing.Any
+
+        meta : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Add metadata to the response by invoking meta functions. Documentation for [meta functions](https://docs.synqly.com/api-reference/meta-functions) is available. Not all meta functions are available at every endpoint.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateSsfEventResponse
+        """
+        _response = self._raw_client.post_event(request=request, meta=meta, request_options=request_options)
+        return _response.data
+
+    def get_transmitter_urls(
+        self,
+        *,
+        meta: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetSsfTransmitterUrlsResponse:
+        """
+        Returns the URLs to register with the receiver: the Issuer URL and the JWKS URL, and the discovery URL for receivers that take one instead. Synqly composes all three from the deployment's base URL and the integration ID, so they always agree with each other.
+
+        Parameters
+        ----------
+        meta : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Add metadata to the response by invoking meta functions. Documentation for [meta functions](https://docs.synqly.com/api-reference/meta-functions) is available. Not all meta functions are available at every endpoint.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetSsfTransmitterUrlsResponse
+        """
+        _response = self._raw_client.get_transmitter_urls(meta=meta, request_options=request_options)
+        return _response.data
+
+
+class AsyncSsfClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSsfClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSsfClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSsfClient
+        """
+        return self._raw_client
+
+    async def post_event(
+        self,
+        *,
+        request: typing.Any,
+        meta: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateSsfEventResponse:
+        """
+        Signs a security signal as a Security Event Token and delivers it to the receiver configured with the token used for authentication. A success response means the receiver accepted the token. It does not mean the receiver acted on it.
+
+        Parameters
+        ----------
+        request : typing.Any
+
+        meta : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Add metadata to the response by invoking meta functions. Documentation for [meta functions](https://docs.synqly.com/api-reference/meta-functions) is available. Not all meta functions are available at every endpoint.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateSsfEventResponse
+        """
+        _response = await self._raw_client.post_event(request=request, meta=meta, request_options=request_options)
+        return _response.data
+
+    async def get_transmitter_urls(
+        self,
+        *,
+        meta: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetSsfTransmitterUrlsResponse:
+        """
+        Returns the URLs to register with the receiver: the Issuer URL and the JWKS URL, and the discovery URL for receivers that take one instead. Synqly composes all three from the deployment's base URL and the integration ID, so they always agree with each other.
+
+        Parameters
+        ----------
+        meta : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Add metadata to the response by invoking meta functions. Documentation for [meta functions](https://docs.synqly.com/api-reference/meta-functions) is available. Not all meta functions are available at every endpoint.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetSsfTransmitterUrlsResponse
+        """
+        _response = await self._raw_client.get_transmitter_urls(meta=meta, request_options=request_options)
+        return _response.data