taegis-sdk-python 1.2.21__tar.gz → 1.2.22__tar.gz

{taegis_sdk_python-1.2.21/taegis_sdk_python.egg-info → taegis_sdk_python-1.2.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: taegis-sdk-python
-Version: 1.2.21
+Version: 1.2.22
 Summary: Taegis Python SDK
 Home-page: https://github.com/secureworks/taegis-sdk-python
 Author: Secureworks

taegis_sdk_python-1.2.22/taegis_sdk_python/_version.py

@@ -0,0 +1 @@
+__version__ = "v1.2.22"

{taegis_sdk_python-1.2.21 → taegis_sdk_python-1.2.22}/taegis_sdk_python/services/__init__.py

@@ -88,7 +88,7 @@ class GraphQLService:
         proxy_headers: Optional[LooseHeaders] = None,
         trust_env: bool = False,
         ssl: Optional[Union[SSLContext, Literal[False], Fingerprint]] = None,
-        execute_timeout: Optional[Union[int, float]] = 30,
+        execute_timeout: Optional[Union[int, float]] = 300,
         max_message_size: int = 0,
     ):  # pylint: disable=too-many-statements
         """

{taegis_sdk_python-1.2.21 → taegis_sdk_python-1.2.22}/taegis_sdk_python/services/alerts/types.py

@@ -2132,6 +2132,9 @@ class AlertsMetadata:
     description: Optional[str] = field(
         default=None, metadata=config(field_name="description")
     )
+    read_only: Optional[bool] = field(
+        default=None, metadata=config(field_name="read_only")
+    )
     creator: Optional[Creator] = field(
         default=None, metadata=config(field_name="creator")
     )

{taegis_sdk_python-1.2.21 → taegis_sdk_python-1.2.22}/taegis_sdk_python/services/assets2/types.py

@@ -1338,6 +1338,9 @@ class AssetV2:
     un_installable: Optional[bool] = field(
         default=None, metadata=config(field_name="unInstallable")
     )
+    agent_policy_version: Optional[str] = field(
+        default=None, metadata=config(field_name="agentPolicyVersion")
+    )
     hostnames: Optional[List[HostnameV2]] = field(
         default=None, metadata=config(field_name="hostnames")
     )
@@ -1381,17 +1384,6 @@ class BulkReconnectNativeAssetsInput:
     )
 
 
-@dataclass_json
-@dataclass(order=True, eq=True, frozen=True)
-class BulkUninstallNativeAssetsInput:
-    """BulkUninstallNativeAssetsInput."""
-
-    reason: Optional[str] = field(default=None, metadata=config(field_name="reason"))
-    where: Optional[AssetWhereInputV2] = field(
-        default=None, metadata=config(field_name="where")
-    )
-
-
 @dataclass_json
 @dataclass(order=True, eq=True, frozen=True)
 class AssetsV2:
@@ -1569,3 +1561,24 @@ class BulkUpdateTagsForEndpointsInputV2:
     tags: Optional[List[KVTagInputV2]] = field(
         default=None, metadata=config(field_name="tags")
     )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class BulkUninstallNativeAssetsInput:
+    """BulkUninstallNativeAssetsInput."""
+
+    reason: Optional[str] = field(default=None, metadata=config(field_name="reason"))
+    agent_count: Optional[int] = field(
+        default=None, metadata=config(field_name="agentCount")
+    )
+    filter: Optional[AssetFilter] = field(
+        default=None, metadata=config(field_name="filter")
+    )
+    where: Optional[AssetWhereInputV2] = field(
+        default=None,
+        metadata=config(
+            metadata={"deprecated": True, "deprecation_reason": "use filter.where"},
+            field_name="where",
+        ),
+    )

taegis_sdk_python-1.2.22/taegis_sdk_python/services/datasources/queries.py

@@ -0,0 +1,125 @@
+"""Datasources Query."""
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python._consts import TaegisEnum
+from taegis_sdk_python.services.datasources.types import *
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.datasources import DatasourcesService
+
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKDatasourcesQuery:
+    """Taegis Datasources Query operations."""
+
+    def __init__(self, service: DatasourcesService):
+        self.service = service
+
+    def get_data_source_last_seen_asset(
+        self, input_: Optional[GetDataSourceInput] = None
+    ) -> List[LastSeenAsset]:
+        """Fetches the last seen data about all data sources associated with a tenant based on input parameters.
+        It provides ability to filter the data by collectorId and sourceId. Authorization permission is
+        required with read access to the collector object.."""
+        endpoint = "getDataSourceLastSeenAsset"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(LastSeenAsset),
+        )
+        if result.get(endpoint) is not None:
+            return LastSeenAsset.schema().load(
+                [r or {} for r in result.get(endpoint)], many=True
+            )
+        raise GraphQLNoRowsInResultSetError("for query getDataSourceLastSeenAsset")
+
+    def get_data_source_last_seen_assets_v2(
+        self,
+        first: Optional[int] = None,
+        last: Optional[int] = None,
+        after: Optional[str] = None,
+        before: Optional[str] = None,
+        filter_: Optional[DataSourceAssetsFilter] = None,
+        sort: Optional[Union[LastSeenAssetsSort, TaegisEnum]] = None,
+    ) -> LastSeenAssets:
+        """Fetches the last seen data about all data sources associated with a tenant based on input parameters.
+        It provides ability to filter the data by collectorId and sourceId. The data returned by this query
+        is eventually consistent. Consequently, actions such as deleting an asset may not be immediately reflected in the
+        result set. Authorization permission is required with read access to the collector object.
+        It also supports forward and backward pagination.."""
+        endpoint = "getDataSourceLastSeenAssetsV2"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "first": prepare_input(first),
+                "last": prepare_input(last),
+                "after": prepare_input(after),
+                "before": prepare_input(before),
+                "filter": prepare_input(filter_),
+                "sort": prepare_input(sort),
+            },
+            output=build_output_string(LastSeenAssets),
+        )
+        if result.get(endpoint) is not None:
+            return LastSeenAssets.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query getDataSourceLastSeenAssetsV2")
+
+    def get_data_source_last_seen_asset_filter_values(
+        self, input_: List[Union[FilterCriteria, TaegisEnum]]
+    ) -> List[FilterValues]:
+        """Provides clients with the ability to retrieve the possible values for a given filter criteria. Note that unique
+        values will be returned, for enum types, only those observed in the data set will be returned.."""
+        endpoint = "getDataSourceLastSeenAssetFilterValues"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(FilterValues),
+        )
+        if result.get(endpoint) is not None:
+            return FilterValues.schema().load(
+                [r or {} for r in result.get(endpoint)], many=True
+            )
+        raise GraphQLNoRowsInResultSetError(
+            "for query getDataSourceLastSeenAssetFilterValues"
+        )
+
+    def data_source_last_seen_assets_query(
+        self, input_: LastSeenQueryInput
+    ) -> LastSeenAssetsQueryResult:
+        """Allows querying last seen data for assets using CQL."""
+        endpoint = "dataSourceLastSeenAssetsQuery"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(LastSeenAssetsQueryResult),
+        )
+        if result.get(endpoint) is not None:
+            return LastSeenAssetsQueryResult.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query dataSourceLastSeenAssetsQuery")

taegis_sdk_python-1.2.22/taegis_sdk_python/services/datasources/types.py

@@ -0,0 +1,290 @@
+"""Datasources Types and Enums."""
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code
+
+# Autogenerated
+# DO NOT MODIFY
+
+from dataclasses import dataclass, field
+
+from enum import Enum
+
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+from dataclasses_json import config, dataclass_json
+
+
+from taegis_sdk_python._consts import TaegisEnum
+from taegis_sdk_python.utils import encode_enum, decode_enum
+
+
+class AuthzObject(str, Enum):
+    """AuthzObject."""
+
+    COLLECTOR = "COLLECTOR"
+
+
+class AuthzAction(str, Enum):
+    """AuthzAction."""
+
+    READ = "READ"
+    DELETE = "DELETE"
+
+
+class HealthState(str, Enum):
+    """HealthState."""
+
+    HEALTHY = "HEALTHY"
+    NO_DATA = "NO_DATA"
+    WARNING = "WARNING"
+
+
+class FilterCriteria(str, Enum):
+    """FilterCriteria."""
+
+    SOURCE_ID = "SOURCE_ID"
+    STATUS = "STATUS"
+    TYPE = "TYPE"
+    SENSOR_TYPE = "SENSOR_TYPE"
+    XDR_RELAY = "XDR_RELAY"
+
+
+class LastSeenAssetsSort(str, Enum):
+    """LastSeenAssetsSort."""
+
+    SOURCE_ID_ASC = "SOURCE_ID_ASC"
+    SOURCE_ID_DESC = "SOURCE_ID_DESC"
+    STATUS_ASC = "STATUS_ASC"
+    STATUS_DESC = "STATUS_DESC"
+    LOG_LAST_SEEN_ASC = "LOG_LAST_SEEN_ASC"
+    LOG_LAST_SEEN_DESC = "LOG_LAST_SEEN_DESC"
+    TYPE_ASC = "TYPE_ASC"
+    TYPE_DESC = "TYPE_DESC"
+    SENSOR_TYPE_ASC = "SENSOR_TYPE_ASC"
+    SENSOR_TYPE_DESC = "SENSOR_TYPE_DESC"
+    COLLECTOR_ID_ASC = "COLLECTOR_ID_ASC"
+    COLLECTOR_ID_DESC = "COLLECTOR_ID_DESC"
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class DeletedAsset:
+    """DeletedAsset."""
+
+    source_id: Optional[str] = field(
+        default=None, metadata=config(field_name="sourceId")
+    )
+    collector_id: Optional[str] = field(
+        default=None, metadata=config(field_name="collectorID")
+    )
+    successful: Optional[bool] = field(
+        default=None, metadata=config(field_name="successful")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class DeleteAssetInput:
+    """DeleteAssetInput."""
+
+    source_id: Optional[str] = field(
+        default=None, metadata=config(field_name="sourceId")
+    )
+    collector_id: Optional[str] = field(
+        default=None, metadata=config(field_name="collectorId")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class GetDataSourceInput:
+    """GetDataSourceInput."""
+
+    collector_id: Optional[str] = field(
+        default=None, metadata=config(field_name="collectorId")
+    )
+    source_id: Optional[str] = field(
+        default=None, metadata=config(field_name="sourceId")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class PageInfo:
+    """PageInfo."""
+
+    end_cursor: Optional[str] = field(
+        default=None, metadata=config(field_name="endCursor")
+    )
+    start_cursor: Optional[str] = field(
+        default=None, metadata=config(field_name="startCursor")
+    )
+    has_next_page: Optional[bool] = field(
+        default=None, metadata=config(field_name="hasNextPage")
+    )
+    has_previous_page: Optional[bool] = field(
+        default=None, metadata=config(field_name="hasPreviousPage")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class QLPageCursor:
+    """QLPageCursor."""
+
+    next_cursor: Optional[str] = field(
+        default=None, metadata=config(field_name="nextCursor")
+    )
+    previous_cursor: Optional[str] = field(
+        default=None, metadata=config(field_name="previousCursor")
+    )
+    cursor: Optional[str] = field(default=None, metadata=config(field_name="cursor"))
+    count: Optional[int] = field(default=None, metadata=config(field_name="count"))
+    total_count: Optional[int] = field(
+        default=None, metadata=config(field_name="totalCount")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class DataSourcesWhereInput:
+    """DataSourcesWhereInput."""
+
+    source_id: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="sourceId")
+    )
+    type: Optional[List[str]] = field(default=None, metadata=config(field_name="type"))
+    sensor_type: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="sensorType")
+    )
+    collector_id: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="collectorId")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class LastSeenQueryInput:
+    """LastSeenQueryInput."""
+
+    ql: Optional[str] = field(default=None, metadata=config(field_name="ql"))
+    cursor: Optional[str] = field(default=None, metadata=config(field_name="cursor"))
+    count: Optional[int] = field(default=None, metadata=config(field_name="count"))
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class FilterValue:
+    """FilterValue."""
+
+    value: Optional[str] = field(default=None, metadata=config(field_name="value"))
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class ClusterIdentity:
+    """ClusterIdentity."""
+
+    id: Optional[str] = field(default=None, metadata=config(field_name="id"))
+    name: Optional[str] = field(default=None, metadata=config(field_name="name"))
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class FilterValues:
+    """FilterValues."""
+
+    filter: Optional[Union[FilterCriteria, TaegisEnum]] = field(
+        default=None,
+        metadata=config(
+            encoder=encode_enum,
+            decoder=lambda x: decode_enum(FilterCriteria, x),
+            field_name="filter",
+        ),
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class LastSeenAsset:
+    """LastSeenAsset."""
+
+    source_id: Optional[str] = field(
+        default=None, metadata=config(field_name="sourceId")
+    )
+    service: Optional[str] = field(default=None, metadata=config(field_name="service"))
+    sensor_type: Optional[str] = field(
+        default=None, metadata=config(field_name="sensorType")
+    )
+    collector_id: Optional[str] = field(
+        default=None, metadata=config(field_name="collectorID")
+    )
+    last_seen: Optional[int] = field(
+        default=None, metadata=config(field_name="lastSeen")
+    )
+    health: Optional[Union[HealthState, TaegisEnum]] = field(
+        default=None,
+        metadata=config(
+            encoder=encode_enum,
+            decoder=lambda x: decode_enum(HealthState, x),
+            field_name="health",
+        ),
+    )
+    collector: Optional[ClusterIdentity] = field(
+        default=None, metadata=config(field_name="collector")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class DataSourceAssetsFilter:
+    """DataSourceAssetsFilter."""
+
+    status: Optional[List[Union[HealthState, TaegisEnum]]] = field(
+        default=None,
+        metadata=config(
+            encoder=encode_enum,
+            decoder=lambda x: decode_enum(HealthState, x),
+            field_name="status",
+        ),
+    )
+    where: Optional[DataSourcesWhereInput] = field(
+        default=None, metadata=config(field_name="where")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class LastSeenAssets:
+    """LastSeenAssets."""
+
+    total_count: Optional[int] = field(
+        default=None, metadata=config(field_name="totalCount")
+    )
+    assets: Optional[List[LastSeenAsset]] = field(
+        default=None, metadata=config(field_name="assets")
+    )
+    page_info: Optional[PageInfo] = field(
+        default=None, metadata=config(field_name="pageInfo")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class LastSeenAssetsQueryResult:
+    """LastSeenAssetsQueryResult."""
+
+    aggregations: Optional[List[dict]] = field(
+        default=None, metadata=config(field_name="aggregations")
+    )
+    assets: Optional[List[LastSeenAsset]] = field(
+        default=None, metadata=config(field_name="assets")
+    )
+    pagination: Optional[QLPageCursor] = field(
+        default=None, metadata=config(field_name="pagination")
+    )
+
+
+FilterValueResponse = Union[
+    FilterValue,
+    ClusterIdentity,
+]

{taegis_sdk_python-1.2.21 → taegis_sdk_python-1.2.22}/taegis_sdk_python/services/file_info/types.py

@@ -840,6 +840,9 @@ class HostDetails:
 class FileMarkingStatus:
     """FileMarkingStatus."""
 
+    file_resource: Optional[str] = field(
+        default=None, metadata=config(field_name="fileResource")
+    )
     explanation: Optional[str] = field(
         default=None, metadata=config(field_name="explanation")
     )

{taegis_sdk_python-1.2.21 → taegis_sdk_python-1.2.22}/taegis_sdk_python/services/isensor/mutations.py

@@ -139,3 +139,40 @@ class TaegisSDKIsensorMutation:
         raise GraphQLNoRowsInResultSetError(
             "for mutation iSensorRuleVariableCustomizations"
         )
+
+    def ndr_save_maintenance_window(
+        self, input_: NdrMaintenanceWindowInput
+    ) -> NdrMaintenanceWindowResult:
+        """Create a new ndr device maintenance window of a given input."""
+        endpoint = "ndrSaveMaintenanceWindow"
+
+        result = self.service.execute_mutation(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(NdrMaintenanceWindowResult),
+        )
+        if result.get(endpoint) is not None:
+            return NdrMaintenanceWindowResult.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for mutation ndrSaveMaintenanceWindow")
+
+    def ndr_defer_maintenance_event_device(
+        self, id_: str, idn: str
+    ) -> NdrDeferEventDeviceResult:
+        """Defer Event Device event for given id."""
+        endpoint = "ndrDeferMaintenanceEventDevice"
+
+        result = self.service.execute_mutation(
+            endpoint=endpoint,
+            variables={
+                "id": prepare_input(id_),
+                "idn": prepare_input(idn),
+            },
+            output=build_output_string(NdrDeferEventDeviceResult),
+        )
+        if result.get(endpoint) is not None:
+            return NdrDeferEventDeviceResult.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError(
+            "for mutation ndrDeferMaintenanceEventDevice"
+        )

{taegis_sdk_python-1.2.21 → taegis_sdk_python-1.2.22}/taegis_sdk_python/services/isensor/queries.py

@@ -45,6 +45,21 @@ class TaegisSDKIsensorQuery:
             )
         raise GraphQLNoRowsInResultSetError("for query iSensorDetails")
 
+    def i_sensor_details_by_id(self, id_: str) -> IsensorDetail:
+        """Get NDR overview data."""
+        endpoint = "iSensorDetailsByID"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "id": prepare_input(id_),
+            },
+            output=build_output_string(IsensorDetail),
+        )
+        if result.get(endpoint) is not None:
+            return IsensorDetail.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query iSensorDetailsByID")
+
     def i_sensor_firewall_rules(self, id_: str) -> IsensorFirewallRules:
         """Get iSensor firewall rules."""
         endpoint = "iSensorFirewallRules"
@@ -170,3 +185,37 @@ class TaegisSDKIsensorQuery:
         if result.get(endpoint) is not None:
             return ISensorArtifact.from_dict(result.get(endpoint))
         raise GraphQLNoRowsInResultSetError("for query iSensorChangeMgmtReportLocation")
+
+    def ndr_maintenance_windows(self, idn: str) -> List[NdrMaintenanceWindowResult]:
+        """Get NDR Device Maintenance window."""
+        endpoint = "ndrMaintenanceWindows"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "idn": prepare_input(idn),
+            },
+            output=build_output_string(NdrMaintenanceWindowResult),
+        )
+        if result.get(endpoint) is not None:
+            return NdrMaintenanceWindowResult.schema().load(
+                [r or {} for r in result.get(endpoint)], many=True
+            )
+        raise GraphQLNoRowsInResultSetError("for query ndrMaintenanceWindows")
+
+    def ndr_maintenance_event_devices(self, idn: str) -> List[NdrEventDeviceResult]:
+        """Get Upcoming NDR EventDevice Events scheduled for idn."""
+        endpoint = "ndrMaintenanceEventDevices"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "idn": prepare_input(idn),
+            },
+            output=build_output_string(NdrEventDeviceResult),
+        )
+        if result.get(endpoint) is not None:
+            return NdrEventDeviceResult.schema().load(
+                [r or {} for r in result.get(endpoint)], many=True
+            )
+        raise GraphQLNoRowsInResultSetError("for query ndrMaintenanceEventDevices")