stackgen-sdk 0.1.1__py3-none-any.whl

stackgen/generated/exceptions.py

@@ -0,0 +1,216 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

stackgen/generated/models/__init__.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+# import models into model package
+from stackgen.generated.models.alert_analysis_status import AlertAnalysisStatus
+from stackgen.generated.models.alert_attention import AlertAttention
+from stackgen.generated.models.alert_categorization_summary import AlertCategorizationSummary
+from stackgen.generated.models.alert_role import AlertRole
+from stackgen.generated.models.alert_sort_by import AlertSortBy
+from stackgen.generated.models.alert_status import AlertStatus
+from stackgen.generated.models.alert_summary import AlertSummary
+from stackgen.generated.models.alert_sync_run_status import AlertSyncRunStatus
+from stackgen.generated.models.alert_v1 import AlertV1
+from stackgen.generated.models.artifact_info import ArtifactInfo
+from stackgen.generated.models.error_response import ErrorResponse
+from stackgen.generated.models.investigate_alert_request import InvestigateAlertRequest
+from stackgen.generated.models.investigate_response import InvestigateResponse
+from stackgen.generated.models.investigation import Investigation
+from stackgen.generated.models.investigation_evidence import InvestigationEvidence
+from stackgen.generated.models.investigation_evidence_kind import InvestigationEvidenceKind
+from stackgen.generated.models.investigation_evidence_source import InvestigationEvidenceSource
+from stackgen.generated.models.investigation_hypothesis import InvestigationHypothesis
+from stackgen.generated.models.investigation_plain_summary import InvestigationPlainSummary
+from stackgen.generated.models.investigation_prior_incident import InvestigationPriorIncident
+from stackgen.generated.models.investigation_recommended_next_step import InvestigationRecommendedNextStep
+from stackgen.generated.models.investigation_ref import InvestigationRef
+from stackgen.generated.models.investigation_status import InvestigationStatus
+from stackgen.generated.models.investigation_structured_hypothesis_entry import InvestigationStructuredHypothesisEntry
+from stackgen.generated.models.investigation_structured_limitation_entry import InvestigationStructuredLimitationEntry
+from stackgen.generated.models.investigation_structured_rca import InvestigationStructuredRCA
+from stackgen.generated.models.investigation_triage_metadata import InvestigationTriageMetadata
+from stackgen.generated.models.json_error import JsonError
+from stackgen.generated.models.list_alerts_response import ListAlertsResponse
+from stackgen.generated.models.list_investigations_response import ListInvestigationsResponse
+from stackgen.generated.models.pagination import Pagination
+from stackgen.generated.models.schedule_run_status import ScheduleRunStatus
+from stackgen.generated.models.schedule_target_type import ScheduleTargetType
+from stackgen.generated.models.session import Session
+from stackgen.generated.models.session_responder_kind import SessionResponderKind
+from stackgen.generated.models.signal_severity import SignalSeverity
+from stackgen.generated.models.sync_response import SyncResponse
+from stackgen.generated.models.trigger_webhook202_response import TriggerWebhook202Response
+from stackgen.generated.models.webhook_run import WebhookRun
+from stackgen.generated.models.webhook_run_detail import WebhookRunDetail
+from stackgen.generated.models.webhook_run_list_response import WebhookRunListResponse

stackgen/generated/models/alert_analysis_status.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AlertAnalysisStatus(str, Enum):
+    """
+    Progress of Aiden auto-analysis on an alert. Never set by the operator.
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'none'
+    QUEUED = 'queued'
+    RUNNING = 'running'
+    COMPLETED = 'completed'
+    FAILED = 'failed'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AlertAnalysisStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/alert_attention.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AlertAttention(str, Enum):
+    """
+    Triage classification for an alert, set by Aiden auto-analysis or an analyst.
+    """
+
+    """
+    allowed enum values
+    """
+    NEEDS_ATTENTION = 'needs_attention'
+    NEEDS_REVIEW = 'needs_review'
+    FALSE_POSITIVE = 'false_positive'
+    OTHERS = 'others'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AlertAttention from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/alert_categorization_summary.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlertCategorizationSummary(BaseModel):
+    """
+    Progress counts for Aiden alert categorization across active alerts. Use is_running to show the loading state while categorization workflows are queued or running, and failed to explain alerts that could not be categorized automatically.
+    """ # noqa: E501
+    total_active: StrictInt = Field(description="Total number of alerts with status=active.")
+    not_started: StrictInt = Field(description="Count of active alerts with analysis_status=none.")
+    in_progress: StrictInt = Field(description="Count of active alerts with analysis_status=queued or running.")
+    completed: StrictInt = Field(description="Count of active alerts with analysis_status=completed.")
+    failed: StrictInt = Field(description="Count of active alerts with analysis_status=failed.")
+    is_running: StrictBool = Field(description="True when at least one active alert is queued or running categorization.")
+    __properties: ClassVar[List[str]] = ["total_active", "not_started", "in_progress", "completed", "failed", "is_running"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AlertCategorizationSummary from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlertCategorizationSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total_active": obj.get("total_active"),
+            "not_started": obj.get("not_started"),
+            "in_progress": obj.get("in_progress"),
+            "completed": obj.get("completed"),
+            "failed": obj.get("failed"),
+            "is_running": obj.get("is_running")
+        })
+        return _obj
+
+

stackgen/generated/models/alert_role.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AlertRole(str, Enum):
+    """
+    Cause-effect role for an alert in a correlated storm. Symptom alerts (latency, 5xx) surface user impact; cause alerts (pool exhaustion, CPU, restarts) point to upstream failure modes. Set by ingest heuristics or refined by Aiden triage.
+    """
+
+    """
+    allowed enum values
+    """
+    SYMPTOM = 'symptom'
+    CAUSE = 'cause'
+    UNKNOWN = 'unknown'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AlertRole from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/alert_sort_by.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AlertSortBy(str, Enum):
+    """
+    Ordering for the alert inbox. severity keeps monitor-rank sort; impact surfaces estimated blast radius (env, scope, storm) first. 
+    """
+
+    """
+    allowed enum values
+    """
+    SEVERITY = 'severity'
+    IMPACT = 'impact'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AlertSortBy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/alert_status.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AlertStatus(str, Enum):
+    """
+    Lifecycle status of an alert.
+    """
+
+    """
+    allowed enum values
+    """
+    ACTIVE = 'active'
+    RESOLVED = 'resolved'
+    IGNORED = 'ignored'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AlertStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/alert_summary.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlertSummary(BaseModel):
+    """
+    Fixed counts for active alerts by triage attention category.
+    """ # noqa: E501
+    total_active: StrictInt = Field(description="Total number of alerts with status=active.")
+    needs_attention: StrictInt = Field(description="Count of active alerts with attention=needs_attention.")
+    others: StrictInt = Field(description="Count of active alerts with attention=others.")
+    needs_review: StrictInt = Field(description="Count of active alerts with attention=needs_review.")
+    false_positive: StrictInt = Field(description="Count of active alerts with attention=false_positive.")
+    __properties: ClassVar[List[str]] = ["total_active", "needs_attention", "others", "needs_review", "false_positive"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AlertSummary from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlertSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total_active": obj.get("total_active"),
+            "needs_attention": obj.get("needs_attention"),
+            "others": obj.get("others"),
+            "needs_review": obj.get("needs_review"),
+            "false_positive": obj.get("false_positive")
+        })
+        return _obj
+
+