stackgen-sdk 0.1.1__py3-none-any.whl

stackgen/generated/models/webhook_run_detail.py

@@ -0,0 +1,136 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from stackgen.generated.models.schedule_run_status import ScheduleRunStatus
+from stackgen.generated.models.schedule_target_type import ScheduleTargetType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebhookRunDetail(BaseModel):
+    """
+    WebhookRunDetail
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="Unique webhook invocation identifier.")
+    webhook_id: Optional[StrictStr] = Field(default=None, description="Webhook configuration that received this invocation.")
+    webhook_name: Optional[StrictStr] = Field(default=None, description="Webhook name snapshot at invocation time.")
+    target_type: Optional[ScheduleTargetType] = None
+    target_name: Optional[StrictStr] = Field(default=None, description="Target agent or workflow name snapshot at invocation time.")
+    status: Optional[ScheduleRunStatus] = None
+    started_at: Optional[datetime] = Field(default=None, description="Timestamp when the webhook was accepted.")
+    finished_at: Optional[datetime] = Field(default=None, description="Timestamp when dispatch completed, if known.")
+    duration_ms: Optional[StrictInt] = Field(default=None, description="Dispatch duration in milliseconds when finished_at is present.")
+    error: Optional[StrictStr] = Field(default=None, description="Error message if dispatch failed.")
+    run_id: Optional[StrictStr] = Field(default=None, description="Downstream Temporal execution run ID, empty until available.")
+    trace_id: Optional[StrictStr] = Field(default=None, description="Execution trace identifier used by the subscribe endpoint.")
+    session_id: Optional[StrictStr] = Field(default=None, description="Downstream session identifier for the dispatched run. Used to correlate this invocation with execution_agent_summaries and the NATS session stream. Empty until dispatch starts a run. ")
+    subscribe_url: Optional[StrictStr] = Field(default=None, description="Relative SSE subscribe URL for the execution trace.")
+    client_ip: Optional[StrictStr] = Field(default=None, description="Source IP address observed by the webhook handler.")
+    payload_bytes: Optional[StrictInt] = Field(default=None, description="Original serialized payload size in bytes.")
+    payload_truncated: Optional[StrictBool] = Field(default=None, description="Whether the stored payload was replaced by a bounded preview.")
+    payload_preview: Optional[StrictStr] = Field(default=None, description="Bounded payload preview, populated when payload_truncated is true.")
+    payload: Optional[Dict[str, Any]] = Field(default=None, description="Stored JSON request payload, omitted or replaced with preview metadata when truncated.")
+    __properties: ClassVar[List[str]] = ["id", "webhook_id", "webhook_name", "target_type", "target_name", "status", "started_at", "finished_at", "duration_ms", "error", "run_id", "trace_id", "session_id", "subscribe_url", "client_ip", "payload_bytes", "payload_truncated", "payload_preview", "payload"]
+
+    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 WebhookRunDetail 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,
+        )
+        # set to None if finished_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.finished_at is None and "finished_at" in self.model_fields_set:
+            _dict['finished_at'] = None
+
+        # set to None if payload (nullable) is None
+        # and model_fields_set contains the field
+        if self.payload is None and "payload" in self.model_fields_set:
+            _dict['payload'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebhookRunDetail from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "webhook_id": obj.get("webhook_id"),
+            "webhook_name": obj.get("webhook_name"),
+            "target_type": obj.get("target_type"),
+            "target_name": obj.get("target_name"),
+            "status": obj.get("status"),
+            "started_at": obj.get("started_at"),
+            "finished_at": obj.get("finished_at"),
+            "duration_ms": obj.get("duration_ms"),
+            "error": obj.get("error"),
+            "run_id": obj.get("run_id"),
+            "trace_id": obj.get("trace_id"),
+            "session_id": obj.get("session_id"),
+            "subscribe_url": obj.get("subscribe_url"),
+            "client_ip": obj.get("client_ip"),
+            "payload_bytes": obj.get("payload_bytes"),
+            "payload_truncated": obj.get("payload_truncated"),
+            "payload_preview": obj.get("payload_preview"),
+            "payload": obj.get("payload")
+        })
+        return _obj
+
+

stackgen/generated/models/webhook_run_list_response.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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from stackgen.generated.models.webhook_run import WebhookRun
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebhookRunListResponse(BaseModel):
+    """
+    Paginated webhook invocation history.
+    """ # noqa: E501
+    items: Optional[List[WebhookRun]] = Field(default=None, description="Array of webhook invocation records ordered newest-first.")
+    total: Optional[StrictInt] = Field(default=None, description="Total number of matching webhook invocations.")
+    __properties: ClassVar[List[str]] = ["items", "total"]
+
+    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 WebhookRunListResponse 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebhookRunListResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "items": [WebhookRun.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "total": obj.get("total")
+        })
+        return _obj
+
+

stackgen/generated/rest.py

@@ -0,0 +1,258 @@
+# 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
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from stackgen.generated.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

stackgen/sre/__init__.py

@@ -0,0 +1,5 @@
+"""SRE app namespace."""
+
+from stackgen.sre.namespace import SRENamespace
+
+__all__ = ["SRENamespace"]

stackgen/sre/namespace.py

@@ -0,0 +1,57 @@
+"""SRE namespace — alerts and investigations."""
+
+from __future__ import annotations
+
+import json
+import urllib.parse
+from typing import Any
+
+from stackgen import _http
+from stackgen.config import StackgenConfig
+
+
+def query_string(params: dict[str, Any]) -> str:
+    """Build a query string from optional kwargs (omit None values)."""
+    cleaned = {k: v for k, v in params.items() if v is not None}
+    if not cleaned:
+        return ""
+    return "?" + urllib.parse.urlencode(cleaned)
+
+
+class SRENamespace:
+    """SRE alerts and investigations."""
+
+    def __init__(self, config: StackgenConfig) -> None:
+        self._config = config
+
+    def list_alerts(self, **params: Any) -> Any:
+        """GET /app/sre/api/v1/alerts"""
+        url = f"{self._config.sre_url()}/api/v1/alerts{query_string(params)}"
+        return _http.request(url, self._config.api_token)
+
+    def get_alert(self, alert_id: str) -> Any:
+        """GET /app/sre/api/v1/alerts/{id} (operationId getAlertV1)."""
+        url = f"{self._config.sre_url()}/api/v1/alerts/{alert_id}"
+        return _http.request(url, self._config.api_token)
+
+    def investigate_alert(self, alert_id: str, body: dict[str, Any] | None = None) -> Any:
+        """POST /app/sre/api/v1/alerts/{id}/investigate"""
+        url = f"{self._config.sre_url()}/api/v1/alerts/{alert_id}/investigate"
+        payload = json.dumps(body or {}).encode("utf-8")
+        return _http.request(
+            url,
+            self._config.api_token,
+            method="POST",
+            body=payload,
+            content_type="application/json",
+        )
+
+    def list_investigations(self, **params: Any) -> Any:
+        """GET /app/sre/api/v1/investigations"""
+        url = f"{self._config.sre_url()}/api/v1/investigations{query_string(params)}"
+        return _http.request(url, self._config.api_token)
+
+    def get_investigation(self, investigation_id: str) -> Any:
+        """GET /app/sre/api/v1/investigations/{id}"""
+        url = f"{self._config.sre_url()}/api/v1/investigations/{investigation_id}"
+        return _http.request(url, self._config.api_token)

stackgen/vault/__init__.py

@@ -0,0 +1,5 @@
+"""Vault namespace (opt-in via allowlist; empty in v0.1)."""
+
+from stackgen.vault.namespace import VaultNamespace
+
+__all__ = ["VaultNamespace"]

stackgen/vault/namespace.py

@@ -0,0 +1,17 @@
+"""Vault namespace — secrets (allowlisted separately)."""
+
+from __future__ import annotations
+
+from stackgen.config import StackgenConfig
+from stackgen.errors import NotAllowlistedError
+
+
+class VaultNamespace:
+    """Vault secrets. Operations are allowlisted separately; v0.1 ships none."""
+
+    def __init__(self, config: StackgenConfig) -> None:
+        self._config = config
+
+    def get_secret(self, secret_id: str) -> None:
+        _ = secret_id
+        raise NotAllowlistedError("vault", "get_secret")

stackgen_sdk-0.1.1.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.5
+Name: stackgen-sdk
+Version: 0.1.1
+Summary: StackGen SDK — Aiden, SRE, and Vault from one client
+Project-URL: Homepage, https://github.com/appcd-dev/stackgen-sdk
+Project-URL: Documentation, https://github.com/appcd-dev/stackgen-sdk/tree/main/docs
+Project-URL: Repository, https://github.com/appcd-dev/stackgen-sdk
+Project-URL: Issues, https://github.com/appcd-dev/stackgen-sdk/issues
+Author: StackGen
+License-Expression: Apache-2.0
+Keywords: aiden,openapi,sre,stackgen
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dateutil>=2.8
+Requires-Dist: typing-extensions>=4.0
+Requires-Dist: urllib3>=2.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# StackGen Python SDK
+
+Install (PyPI):
+
+```bash
+pip install stackgen-sdk==0.1.1
+```
+
+Developers with private repo access:
+
+```bash
+pip install "git+ssh://git@github.com/appcd-dev/stackgen-sdk.git@v0.1.1#subdirectory=clients/python"
+```
+
+Quick start:
+
+```python
+from stackgen import StackgenClient
+
+client = StackgenClient.from_env()
+result = client.aiden.run_webhook_and_download_report(open("alert.json").read())
+print(result.session_id, result.output_path)
+
+alerts = client.sre.list_alerts()
+```
+
+Environment:
+
+| Variable | Purpose |
+|----------|---------|
+| `STACKGEN_URL` | Mothership URL (no `/guild`) |
+| `STACKGEN_TOKEN` | API token (`stackgen_…`) |
+| `WEBHOOK_TOKEN` | Webhook token (`sg_aios_…`) for triggers |
+| `ORG_ID` | Organization UUID |
+| `WEBHOOK_ID` | Optional; older trigger 202 bodies |
+
+See [docs/PRODUCT.md](../../docs/PRODUCT.md), [docs/python/IMPLEMENTATION.md](../../docs/python/IMPLEMENTATION.md), and [docs/PUBLISH.md](../../docs/PUBLISH.md).
+
+Generated OpenAPI client code lives under `stackgen.generated` (unstable; prefer `StackgenClient`).