convexity-api-client 0.6.0.dev173__tar.gz → 0.8.0.dev174__tar.gz

{convexity_api_client-0.6.0.dev173 → convexity_api_client-0.8.0.dev174}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: convexity_api_client
-Version: 0.6.0.dev173
+Version: 0.8.0.dev174
 Summary: A client library for accessing Convexity API
 Requires-Dist: httpx>=0.23.0,<0.29.0
 Requires-Dist: attrs>=22.2.0

convexity_api_client-0.8.0.dev174/convexity_api_client/api/v1/event_stream_v1_events_stream_get.py

@@ -0,0 +1,208 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    *,
+    project_id: str,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["projectId"] = project_id
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/events/stream",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    project_id: str,
+) -> Response[Any | HTTPValidationError]:
+    """Event Stream
+
+     Unified SSE stream for all real-time events within a project.
+
+    Events are differentiated by the SSE ``event:`` field
+    (e.g. ``refresh_started``, ``task_run_started``).
+
+    The connection stays open until the client disconnects.
+    A heartbeat comment (``: heartbeat``) is sent every 30 s to prevent
+    proxy/load-balancer timeouts.
+
+    Requires viewer role (``projectId`` query param for auth).
+
+    Args:
+        project_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    project_id: str,
+) -> Any | HTTPValidationError | None:
+    """Event Stream
+
+     Unified SSE stream for all real-time events within a project.
+
+    Events are differentiated by the SSE ``event:`` field
+    (e.g. ``refresh_started``, ``task_run_started``).
+
+    The connection stays open until the client disconnects.
+    A heartbeat comment (``: heartbeat``) is sent every 30 s to prevent
+    proxy/load-balancer timeouts.
+
+    Requires viewer role (``projectId`` query param for auth).
+
+    Args:
+        project_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        project_id=project_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    project_id: str,
+) -> Response[Any | HTTPValidationError]:
+    """Event Stream
+
+     Unified SSE stream for all real-time events within a project.
+
+    Events are differentiated by the SSE ``event:`` field
+    (e.g. ``refresh_started``, ``task_run_started``).
+
+    The connection stays open until the client disconnects.
+    A heartbeat comment (``: heartbeat``) is sent every 30 s to prevent
+    proxy/load-balancer timeouts.
+
+    Requires viewer role (``projectId`` query param for auth).
+
+    Args:
+        project_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    project_id: str,
+) -> Any | HTTPValidationError | None:
+    """Event Stream
+
+     Unified SSE stream for all real-time events within a project.
+
+    Events are differentiated by the SSE ``event:`` field
+    (e.g. ``refresh_started``, ``task_run_started``).
+
+    The connection stays open until the client disconnects.
+    A heartbeat comment (``: heartbeat``) is sent every 30 s to prevent
+    proxy/load-balancer timeouts.
+
+    Requires viewer role (``projectId`` query param for auth).
+
+    Args:
+        project_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            project_id=project_id,
+        )
+    ).parsed

convexity_api_client-0.8.0.dev174/convexity_api_client/api/v1/event_types_v1_events_types_get.py

@@ -0,0 +1,168 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.refresh_ended_event import RefreshEndedEvent
+from ...models.refresh_started_event import RefreshStartedEvent
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: RefreshEndedEvent | RefreshStartedEvent,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/events/types",
+    }
+
+    if isinstance(body, RefreshStartedEvent):
+        _kwargs["json"] = body.to_dict()
+    else:
+        _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshEndedEvent | RefreshStartedEvent,
+) -> Response[Any | HTTPValidationError]:
+    """Event Types
+
+    Args:
+        body (RefreshEndedEvent | RefreshStartedEvent):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshEndedEvent | RefreshStartedEvent,
+) -> Any | HTTPValidationError | None:
+    """Event Types
+
+    Args:
+        body (RefreshEndedEvent | RefreshStartedEvent):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshEndedEvent | RefreshStartedEvent,
+) -> Response[Any | HTTPValidationError]:
+    """Event Types
+
+    Args:
+        body (RefreshEndedEvent | RefreshStartedEvent):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshEndedEvent | RefreshStartedEvent,
+) -> Any | HTTPValidationError | None:
+    """Event Types
+
+    Args:
+        body (RefreshEndedEvent | RefreshStartedEvent):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

{convexity_api_client-0.6.0.dev173 → convexity_api_client-0.8.0.dev174}/convexity_api_client/models/__init__.py

@@ -235,7 +235,12 @@ from .read_file_request import ReadFileRequest
 from .read_file_response import ReadFileResponse
 from .refresh_dataset_payload import RefreshDatasetPayload
 from .refresh_dataset_payload_parameters_type_0 import RefreshDatasetPayloadParametersType0
+from .refresh_ended_event import RefreshEndedEvent
+from .refresh_ended_payload import RefreshEndedPayload
+from .refresh_ended_payload_status import RefreshEndedPayloadStatus
 from .refresh_mode import RefreshMode
+from .refresh_started_event import RefreshStartedEvent
+from .refresh_started_payload import RefreshStartedPayload
 from .refresh_task import RefreshTask
 from .refresh_task_list_response import RefreshTaskListResponse
 from .refresh_task_status import RefreshTaskStatus
@@ -256,6 +261,7 @@ from .scatter_chart_config_legend_position_type_0 import ScatterChartConfigLegen
 from .scatter_chart_config_orientation_type_0 import ScatterChartConfigOrientationType0
 from .scatter_chart_config_series_styles_type_0 import ScatterChartConfigSeriesStylesType0
 from .scatter_chart_config_symbol_type_0 import ScatterChartConfigSymbolType0
+from .schedule_mode import ScheduleMode
 from .schema_field import SchemaField
 from .schema_response import SchemaResponse
 from .series_style import SeriesStyle
@@ -563,7 +569,12 @@ __all__ = (
     "ReadFileResponse",
     "RefreshDatasetPayload",
     "RefreshDatasetPayloadParametersType0",
+    "RefreshEndedEvent",
+    "RefreshEndedPayload",
+    "RefreshEndedPayloadStatus",
     "RefreshMode",
+    "RefreshStartedEvent",
+    "RefreshStartedPayload",
     "RefreshTask",
     "RefreshTaskListResponse",
     "RefreshTaskStatus",
@@ -584,6 +595,7 @@ __all__ = (
     "ScatterChartConfigOrientationType0",
     "ScatterChartConfigSeriesStylesType0",
     "ScatterChartConfigSymbolType0",
+    "ScheduleMode",
     "SchemaField",
     "SchemaResponse",
     "SeriesStyle",

{convexity_api_client-0.6.0.dev173 → convexity_api_client-0.8.0.dev174}/convexity_api_client/models/create_task_request.py

@@ -21,12 +21,16 @@ class CreateTaskRequest:
         project_id (str):
         scenario (TaskScenario):
         description (None | str | Unset):
+        schedule_mode (None | str | Unset):  Default: 'MANUAL'.
+        schedule_cron (None | str | Unset):
     """
 
     name: str
     project_id: str
     scenario: TaskScenario
     description: None | str | Unset = UNSET
+    schedule_mode: None | str | Unset = "MANUAL"
+    schedule_cron: None | str | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -42,6 +46,18 @@ class CreateTaskRequest:
         else:
             description = self.description
 
+        schedule_mode: None | str | Unset
+        if isinstance(self.schedule_mode, Unset):
+            schedule_mode = UNSET
+        else:
+            schedule_mode = self.schedule_mode
+
+        schedule_cron: None | str | Unset
+        if isinstance(self.schedule_cron, Unset):
+            schedule_cron = UNSET
+        else:
+            schedule_cron = self.schedule_cron
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -53,6 +69,10 @@ class CreateTaskRequest:
         )
         if description is not UNSET:
             field_dict["description"] = description
+        if schedule_mode is not UNSET:
+            field_dict["scheduleMode"] = schedule_mode
+        if schedule_cron is not UNSET:
+            field_dict["scheduleCron"] = schedule_cron
 
         return field_dict
 
@@ -74,11 +94,31 @@ class CreateTaskRequest:
 
         description = _parse_description(d.pop("description", UNSET))
 
+        def _parse_schedule_mode(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        schedule_mode = _parse_schedule_mode(d.pop("scheduleMode", UNSET))
+
+        def _parse_schedule_cron(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        schedule_cron = _parse_schedule_cron(d.pop("scheduleCron", UNSET))
+
         create_task_request = cls(
             name=name,
             project_id=project_id,
             scenario=scenario,
             description=description,
+            schedule_mode=schedule_mode,
+            schedule_cron=schedule_cron,
         )
 
         create_task_request.additional_properties = d

convexity_api_client-0.8.0.dev174/convexity_api_client/models/refresh_ended_event.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, Literal, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.refresh_ended_payload import RefreshEndedPayload
+
+
+T = TypeVar("T", bound="RefreshEndedEvent")
+
+
+@_attrs_define
+class RefreshEndedEvent:
+    """Event emitted when a dataset refresh task finishes.
+
+    Attributes:
+        data (RefreshEndedPayload):
+        event_type (Literal['refresh_ended'] | Unset): Type of event, e.g. 'refresh_ended' Default: 'refresh_ended'.
+    """
+
+    data: RefreshEndedPayload
+    event_type: Literal["refresh_ended"] | Unset = "refresh_ended"
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        data = self.data.to_dict()
+
+        event_type = self.event_type
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "data": data,
+            }
+        )
+        if event_type is not UNSET:
+            field_dict["event_type"] = event_type
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.refresh_ended_payload import RefreshEndedPayload
+
+        d = dict(src_dict)
+        data = RefreshEndedPayload.from_dict(d.pop("data"))
+
+        event_type = cast(Literal["refresh_ended"] | Unset, d.pop("event_type", UNSET))
+        if event_type != "refresh_ended" and not isinstance(event_type, Unset):
+            raise ValueError(f"event_type must match const 'refresh_ended', got '{event_type}'")
+
+        refresh_ended_event = cls(
+            data=data,
+            event_type=event_type,
+        )
+
+        refresh_ended_event.additional_properties = d
+        return refresh_ended_event
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

convexity_api_client-0.8.0.dev174/convexity_api_client/models/refresh_ended_payload.py

@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.refresh_ended_payload_status import RefreshEndedPayloadStatus
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="RefreshEndedPayload")
+
+
+@_attrs_define
+class RefreshEndedPayload:
+    """
+    Attributes:
+        dataset_id (str):
+        task_id (str):
+        status (RefreshEndedPayloadStatus):
+        error (None | str | Unset):
+    """
+
+    dataset_id: str
+    task_id: str
+    status: RefreshEndedPayloadStatus
+    error: None | str | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        dataset_id = self.dataset_id
+
+        task_id = self.task_id
+
+        status = self.status.value
+
+        error: None | str | Unset
+        if isinstance(self.error, Unset):
+            error = UNSET
+        else:
+            error = self.error
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "dataset_id": dataset_id,
+                "task_id": task_id,
+                "status": status,
+            }
+        )
+        if error is not UNSET:
+            field_dict["error"] = error
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        dataset_id = d.pop("dataset_id")
+
+        task_id = d.pop("task_id")
+
+        status = RefreshEndedPayloadStatus(d.pop("status"))
+
+        def _parse_error(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        error = _parse_error(d.pop("error", UNSET))
+
+        refresh_ended_payload = cls(
+            dataset_id=dataset_id,
+            task_id=task_id,
+            status=status,
+            error=error,
+        )
+
+        refresh_ended_payload.additional_properties = d
+        return refresh_ended_payload
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

convexity_api_client-0.8.0.dev174/convexity_api_client/models/refresh_ended_payload_status.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class RefreshEndedPayloadStatus(str, Enum):
+    CANCELLED = "CANCELLED"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+    def __str__(self) -> str:
+        return str(self.value)