synqly 0.3.3__py3-none-any.whl

synqly/engine/__init__.py

@@ -0,0 +1,295 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .resources import (
+    Application,
+    Asset,
+    Attachment,
+    AttachmentId,
+    AttachmentMetadata,
+    BadGatewayError,
+    BadRequestError,
+    Base,
+    BaseResourceRequest,
+    Comment,
+    CommentId,
+    ConflictError,
+    ConnectionState,
+    CreateAssetRequest,
+    CreateAttachmentRequest,
+    CreateAttachmentResponse,
+    CreateCommentRequest,
+    CreateCommentResponse,
+    CreateIocsRequest,
+    CreateIocsResponse,
+    CreateNotificationRequest,
+    CreateNotificationResponse,
+    CreateTicketRequest,
+    CreateTicketResponse,
+    DeleteIocsResponse,
+    Device,
+    DownloadAttachmentResponse,
+    ErrorBody,
+    ErrorParam,
+    Event,
+    EventId,
+    Event_AccountChange,
+    Event_ApiActivity,
+    Event_Authentication,
+    Event_ComplianceFinding,
+    Event_DetectionFinding,
+    Event_FileActivity,
+    Event_GroupManagement,
+    Event_IncidentFinding,
+    Event_InventoryInfo,
+    Event_ModuleActivity,
+    Event_NetworkActivity,
+    Event_ProcessActivity,
+    Event_ScheduledJobActivity,
+    Event_SecurityFinding,
+    Event_VulnerabilityFinding,
+    Event_WebResourceAccessActivity,
+    Evidence,
+    FieldMappingId,
+    ForbiddenError,
+    GatewayTimeoutError,
+    GetEvidenceResponse,
+    GetGroupMembersResponse,
+    GetGroupResponse,
+    GetInvestigationResponse,
+    GetNotificationResponse,
+    GetScanActivityResponse,
+    GetTicketResponse,
+    GetUserResponse,
+    GroupId,
+    Id,
+    InternalServerError,
+    Investigation,
+    IssueTypeId,
+    ListAttachmentsMetadataResponse,
+    ListCommentsResponse,
+    ListProjectsResponse,
+    ListRemoteFieldsResponse,
+    ListStorageResponse,
+    MetaApi,
+    MetaApiPrimaryResponse,
+    MetaApiResponse,
+    MetaResponse,
+    MetaStats,
+    MethodNotAllowedError,
+    NetworkQuarantineRequest,
+    NetworkQuarantineResponse,
+    NotFoundError,
+    NotImplementedError,
+    Notification,
+    NotificationId,
+    NotificationStatus,
+    Object,
+    OrderOptions,
+    PatchInvestigationRequest,
+    PatchTicketResponse,
+    PostureScore,
+    Priority,
+    Project,
+    ProjectId,
+    QueryAlertsResponse,
+    QueryApplicationsResponse,
+    QueryAssetsResponse,
+    QueryDevicesResponse,
+    QueryEndpointsResponse,
+    QueryEventStatus,
+    QueryFindingsResponse,
+    QueryGroupsResponse,
+    QueryIdentityAuditLogResponse,
+    QueryInvestigationResponse,
+    QueryIocsResponse,
+    QueryPostureScoreResponse,
+    QueryScansResponse,
+    QuerySiemEventsResponse,
+    QueryThreatsResponse,
+    QueryTicketsResponse,
+    QueryUsersResponse,
+    RemoteField,
+    RemoteFieldSchema,
+    RemoteFieldScope,
+    RemoteFieldTypeId,
+    ScanConfiguration,
+    ScanDayOption,
+    ScanFrequencyOption,
+    ScanSchedule,
+    SecurityFinding,
+    ServiceUnavailableError,
+    Status,
+    StoragePath,
+    ThreatEvent,
+    Ticket,
+    TicketId,
+    TooManyRequestsError,
+    UnauthorizedError,
+    UnsupportedMediaTypeError,
+    User,
+    UserId,
+    ValueMappingId,
+    VulnerabilitySeverityFilterValue,
+    assets,
+    common,
+    edr,
+    events,
+    hooks,
+    identity,
+    notifications,
+    ocsf,
+    siem,
+    sink,
+    stix,
+    storage,
+    ticketing,
+    vulnerabilities,
+)
+from .environment import SynqlyEngineEnvironment
+
+__all__ = [
+    "Application",
+    "Asset",
+    "Attachment",
+    "AttachmentId",
+    "AttachmentMetadata",
+    "BadGatewayError",
+    "BadRequestError",
+    "Base",
+    "BaseResourceRequest",
+    "Comment",
+    "CommentId",
+    "ConflictError",
+    "ConnectionState",
+    "CreateAssetRequest",
+    "CreateAttachmentRequest",
+    "CreateAttachmentResponse",
+    "CreateCommentRequest",
+    "CreateCommentResponse",
+    "CreateIocsRequest",
+    "CreateIocsResponse",
+    "CreateNotificationRequest",
+    "CreateNotificationResponse",
+    "CreateTicketRequest",
+    "CreateTicketResponse",
+    "DeleteIocsResponse",
+    "Device",
+    "DownloadAttachmentResponse",
+    "ErrorBody",
+    "ErrorParam",
+    "Event",
+    "EventId",
+    "Event_AccountChange",
+    "Event_ApiActivity",
+    "Event_Authentication",
+    "Event_ComplianceFinding",
+    "Event_DetectionFinding",
+    "Event_FileActivity",
+    "Event_GroupManagement",
+    "Event_IncidentFinding",
+    "Event_InventoryInfo",
+    "Event_ModuleActivity",
+    "Event_NetworkActivity",
+    "Event_ProcessActivity",
+    "Event_ScheduledJobActivity",
+    "Event_SecurityFinding",
+    "Event_VulnerabilityFinding",
+    "Event_WebResourceAccessActivity",
+    "Evidence",
+    "FieldMappingId",
+    "ForbiddenError",
+    "GatewayTimeoutError",
+    "GetEvidenceResponse",
+    "GetGroupMembersResponse",
+    "GetGroupResponse",
+    "GetInvestigationResponse",
+    "GetNotificationResponse",
+    "GetScanActivityResponse",
+    "GetTicketResponse",
+    "GetUserResponse",
+    "GroupId",
+    "Id",
+    "InternalServerError",
+    "Investigation",
+    "IssueTypeId",
+    "ListAttachmentsMetadataResponse",
+    "ListCommentsResponse",
+    "ListProjectsResponse",
+    "ListRemoteFieldsResponse",
+    "ListStorageResponse",
+    "MetaApi",
+    "MetaApiPrimaryResponse",
+    "MetaApiResponse",
+    "MetaResponse",
+    "MetaStats",
+    "MethodNotAllowedError",
+    "NetworkQuarantineRequest",
+    "NetworkQuarantineResponse",
+    "NotFoundError",
+    "NotImplementedError",
+    "Notification",
+    "NotificationId",
+    "NotificationStatus",
+    "Object",
+    "OrderOptions",
+    "PatchInvestigationRequest",
+    "PatchTicketResponse",
+    "PostureScore",
+    "Priority",
+    "Project",
+    "ProjectId",
+    "QueryAlertsResponse",
+    "QueryApplicationsResponse",
+    "QueryAssetsResponse",
+    "QueryDevicesResponse",
+    "QueryEndpointsResponse",
+    "QueryEventStatus",
+    "QueryFindingsResponse",
+    "QueryGroupsResponse",
+    "QueryIdentityAuditLogResponse",
+    "QueryInvestigationResponse",
+    "QueryIocsResponse",
+    "QueryPostureScoreResponse",
+    "QueryScansResponse",
+    "QuerySiemEventsResponse",
+    "QueryThreatsResponse",
+    "QueryTicketsResponse",
+    "QueryUsersResponse",
+    "RemoteField",
+    "RemoteFieldSchema",
+    "RemoteFieldScope",
+    "RemoteFieldTypeId",
+    "ScanConfiguration",
+    "ScanDayOption",
+    "ScanFrequencyOption",
+    "ScanSchedule",
+    "SecurityFinding",
+    "ServiceUnavailableError",
+    "Status",
+    "StoragePath",
+    "SynqlyEngineEnvironment",
+    "ThreatEvent",
+    "Ticket",
+    "TicketId",
+    "TooManyRequestsError",
+    "UnauthorizedError",
+    "UnsupportedMediaTypeError",
+    "User",
+    "UserId",
+    "ValueMappingId",
+    "VulnerabilitySeverityFilterValue",
+    "assets",
+    "common",
+    "edr",
+    "events",
+    "hooks",
+    "identity",
+    "notifications",
+    "ocsf",
+    "siem",
+    "sink",
+    "stix",
+    "storage",
+    "ticketing",
+    "vulnerabilities",
+]

synqly/engine/client.py

@@ -0,0 +1,127 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .environment import SynqlyEngineEnvironment
+from .resources.assets.client import AssetsClient, AsyncAssetsClient
+from .resources.edr.client import AsyncEdrClient, EdrClient
+from .resources.hooks.client import AsyncHooksClient, HooksClient
+from .resources.identity.client import AsyncIdentityClient, IdentityClient
+from .resources.notifications.client import AsyncNotificationsClient, NotificationsClient
+from .resources.siem.client import AsyncSiemClient, SiemClient
+from .resources.sink.client import AsyncSinkClient, SinkClient
+from .resources.storage.client import AsyncStorageClient, StorageClient
+from .resources.ticketing.client import AsyncTicketingClient, TicketingClient
+from .resources.vulnerabilities.client import AsyncVulnerabilitiesClient, VulnerabilitiesClient
+
+
+class SynqlyEngine:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+
+        - environment: SynqlyEngineEnvironment. The environment to use for requests from the client. from .environment import SynqlyEngineEnvironment
+
+                                                Defaults to SynqlyEngineEnvironment.SYNQLY
+
+        - token: typing.Union[str, typing.Callable[[], str]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds.
+
+        - httpx_client: typing.Optional[httpx.Client]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from synqly.client import SynqlyEngine
+
+    client = SynqlyEngine(
+        token="YOUR_TOKEN",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: SynqlyEngineEnvironment = SynqlyEngineEnvironment.SYNQLY,
+        token: typing.Union[str, typing.Callable[[], str]],
+        timeout: typing.Optional[float] = 60,
+        httpx_client: typing.Optional[httpx.Client] = None
+    ):
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            httpx_client=httpx.Client(timeout=timeout) if httpx_client is None else httpx_client,
+        )
+        self.assets = AssetsClient(client_wrapper=self._client_wrapper)
+        self.edr = EdrClient(client_wrapper=self._client_wrapper)
+        self.hooks = HooksClient(client_wrapper=self._client_wrapper)
+        self.identity = IdentityClient(client_wrapper=self._client_wrapper)
+        self.notifications = NotificationsClient(client_wrapper=self._client_wrapper)
+        self.siem = SiemClient(client_wrapper=self._client_wrapper)
+        self.sink = SinkClient(client_wrapper=self._client_wrapper)
+        self.storage = StorageClient(client_wrapper=self._client_wrapper)
+        self.ticketing = TicketingClient(client_wrapper=self._client_wrapper)
+        self.vulnerabilities = VulnerabilitiesClient(client_wrapper=self._client_wrapper)
+
+
+class AsyncSynqlyEngine:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+
+        - environment: SynqlyEngineEnvironment. The environment to use for requests from the client. from .environment import SynqlyEngineEnvironment
+
+                                                Defaults to SynqlyEngineEnvironment.SYNQLY
+
+        - token: typing.Union[str, typing.Callable[[], str]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds.
+
+        - httpx_client: typing.Optional[httpx.AsyncClient]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from synqly.client import AsyncSynqlyEngine
+
+    client = AsyncSynqlyEngine(
+        token="YOUR_TOKEN",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: SynqlyEngineEnvironment = SynqlyEngineEnvironment.SYNQLY,
+        token: typing.Union[str, typing.Callable[[], str]],
+        timeout: typing.Optional[float] = 60,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None
+    ):
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            httpx_client=httpx.AsyncClient(timeout=timeout) if httpx_client is None else httpx_client,
+        )
+        self.assets = AsyncAssetsClient(client_wrapper=self._client_wrapper)
+        self.edr = AsyncEdrClient(client_wrapper=self._client_wrapper)
+        self.hooks = AsyncHooksClient(client_wrapper=self._client_wrapper)
+        self.identity = AsyncIdentityClient(client_wrapper=self._client_wrapper)
+        self.notifications = AsyncNotificationsClient(client_wrapper=self._client_wrapper)
+        self.siem = AsyncSiemClient(client_wrapper=self._client_wrapper)
+        self.sink = AsyncSinkClient(client_wrapper=self._client_wrapper)
+        self.storage = AsyncStorageClient(client_wrapper=self._client_wrapper)
+        self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper)
+        self.vulnerabilities = AsyncVulnerabilitiesClient(client_wrapper=self._client_wrapper)
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: SynqlyEngineEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

synqly/engine/core/__init__.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .api_error import ApiError
+from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
+from .datetime_utils import serialize_datetime
+from .file import File, convert_file_dict_to_httpx_tuples
+from .http_client import AsyncHttpClient, HttpClient
+from .jsonable_encoder import jsonable_encoder
+from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
+
+__all__ = [
+    "ApiError",
+    "AsyncClientWrapper",
+    "AsyncHttpClient",
+    "BaseClientWrapper",
+    "File",
+    "HttpClient",
+    "RequestOptions",
+    "SyncClientWrapper",
+    "convert_file_dict_to_httpx_tuples",
+    "jsonable_encoder",
+    "remove_none_from_dict",
+    "serialize_datetime",
+]

synqly/engine/core/api_error.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+
+class ApiError(Exception):
+    status_code: typing.Optional[int]
+    body: typing.Any
+
+    def __init__(self, *, status_code: typing.Optional[int] = None, body: typing.Any = None):
+        self.status_code = status_code
+        self.body = body
+
+    def __str__(self) -> str:
+        return f"status_code: {self.status_code}, body: {self.body}"

synqly/engine/core/client_wrapper.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+from .http_client import AsyncHttpClient, HttpClient
+
+
+class BaseClientWrapper:
+    def __init__(self, *, token: typing.Union[str, typing.Callable[[], str]], base_url: str):
+        self._token = token
+        self._base_url = base_url
+
+    def get_headers(self) -> typing.Dict[str, str]:
+        headers: typing.Dict[str, str] = {"X-Fern-Language": "Python"}
+        headers["Authorization"] = f"Bearer {self._get_token()}"
+        headers["User-Agent"] = "Synqly-Python-SDK/0.3.3"
+        return headers
+
+    def _get_token(self) -> str:
+        if isinstance(self._token, str):
+            return self._token
+        else:
+            return self._token()
+
+    def get_base_url(self) -> str:
+        return self._base_url
+
+
+class SyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self, *, token: typing.Union[str, typing.Callable[[], str]], base_url: str, httpx_client: httpx.Client
+    ):
+        super().__init__(token=token, base_url=base_url)
+        self.httpx_client = HttpClient(httpx_client=httpx_client)
+
+
+class AsyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self, *, token: typing.Union[str, typing.Callable[[], str]], base_url: str, httpx_client: httpx.AsyncClient
+    ):
+        super().__init__(token=token, base_url=base_url)
+        self.httpx_client = AsyncHttpClient(httpx_client=httpx_client)

synqly/engine/core/datetime_utils.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+
+
+def serialize_datetime(v: dt.datetime) -> str:
+    """
+    Serialize a datetime including timezone info.
+
+    Uses the timezone info provided if present, otherwise uses the current runtime's timezone info.
+
+    UTC datetimes end in "Z" while all other timezones are represented as offset from UTC, e.g. +05:00.
+    """
+
+    def _serialize_zoned_datetime(v: dt.datetime) -> str:
+        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(None):
+            # UTC is a special case where we use "Z" at the end instead of "+00:00"
+            return v.isoformat().replace("+00:00", "Z")
+        else:
+            # Delegate to the typical +/- offset format
+            return v.isoformat()
+
+    if v.tzinfo is not None:
+        return _serialize_zoned_datetime(v)
+    else:
+        local_tz = dt.datetime.now().astimezone().tzinfo
+        localized_dt = v.replace(tzinfo=local_tz)
+        return _serialize_zoned_datetime(localized_dt)

synqly/engine/core/file.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+# File typing inspired by the flexibility of types within the httpx library
+# https://github.com/encode/httpx/blob/master/httpx/_types.py
+FileContent = typing.Union[typing.IO[bytes], bytes, str]
+File = typing.Union[
+    # file (or bytes)
+    FileContent,
+    # (filename, file (or bytes))
+    typing.Tuple[typing.Optional[str], FileContent],
+    # (filename, file (or bytes), content_type)
+    typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str]],
+    # (filename, file (or bytes), content_type, headers)
+    typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str], typing.Mapping[str, str]],
+]
+
+
+def convert_file_dict_to_httpx_tuples(
+    d: typing.Dict[str, typing.Union[File, typing.List[File]]]
+) -> typing.List[typing.Tuple[str, File]]:
+    """
+    The format we use is a list of tuples, where the first element is the
+    name of the file and the second is the file object. Typically HTTPX wants
+    a dict, but to be able to send lists of files, you have to use the list
+    approach (which also works for non-lists)
+    https://github.com/encode/httpx/pull/1032
+    """
+
+    httpx_tuples = []
+    for key, file_like in d.items():
+        if isinstance(file_like, list):
+            for file_like_item in file_like:
+                httpx_tuples.append((key, file_like_item))
+        else:
+            httpx_tuples.append((key, file_like))
+    return httpx_tuples