worqhat 3.5.0__py3-none-any.whl → 3.9.0__py3-none-any.whl

worqhat/resources/db/tables.py

@@ -0,0 +1,389 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+import httpx
+
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._utils import maybe_transform, async_maybe_transform
+from ..._compat import cached_property
+from ...types.db import table_list_params, table_get_row_count_params, table_retrieve_schema_params
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ..._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ..._base_client import make_request_options
+from ...types.db.table_list_response import TableListResponse
+from ...types.db.table_get_row_count_response import TableGetRowCountResponse
+from ...types.db.table_retrieve_schema_response import TableRetrieveSchemaResponse
+
+__all__ = ["TablesResource", "AsyncTablesResource"]
+
+
+class TablesResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> TablesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/WorqHat/worqhat-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return TablesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> TablesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/WorqHat/worqhat-python-sdk#with_streaming_response
+        """
+        return TablesResourceWithStreamingResponse(self)
+
+    def list(
+        self,
+        *,
+        environment: Literal["development", "staging", "production"] | Omit = omit,
+        schema: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> TableListResponse:
+        """
+        Returns a list of all tables in the database that are accessible to your
+        organization. Optionally filter by schema and environment.
+
+        Args:
+          environment: Environment to query (development, staging, production)
+
+          schema: Database schema to filter tables
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            "/db/tables",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "environment": environment,
+                        "schema": schema,
+                    },
+                    table_list_params.TableListParams,
+                ),
+            ),
+            cast_to=TableListResponse,
+        )
+
+    def get_row_count(
+        self,
+        table_name: str,
+        *,
+        environment: Literal["development", "staging", "production"] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> TableGetRowCountResponse:
+        """
+        Returns the total number of rows in the specified table for your organization.
+
+        Args:
+          environment: Environment to query
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not table_name:
+            raise ValueError(f"Expected a non-empty value for `table_name` but received {table_name!r}")
+        return self._get(
+            f"/db/tables/{table_name}/count",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"environment": environment}, table_get_row_count_params.TableGetRowCountParams),
+            ),
+            cast_to=TableGetRowCountResponse,
+        )
+
+    def retrieve_schema(
+        self,
+        table_name: str,
+        *,
+        environment: Literal["development", "staging", "production"] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> TableRetrieveSchemaResponse:
+        """
+        Returns detailed schema information for a specific table, including column
+        names, types, and constraints.
+
+        Args:
+          environment: Environment to query
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not table_name:
+            raise ValueError(f"Expected a non-empty value for `table_name` but received {table_name!r}")
+        return self._get(
+            f"/db/tables/{table_name}/schema",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {"environment": environment}, table_retrieve_schema_params.TableRetrieveSchemaParams
+                ),
+            ),
+            cast_to=TableRetrieveSchemaResponse,
+        )
+
+
+class AsyncTablesResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncTablesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/WorqHat/worqhat-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return AsyncTablesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncTablesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/WorqHat/worqhat-python-sdk#with_streaming_response
+        """
+        return AsyncTablesResourceWithStreamingResponse(self)
+
+    async def list(
+        self,
+        *,
+        environment: Literal["development", "staging", "production"] | Omit = omit,
+        schema: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> TableListResponse:
+        """
+        Returns a list of all tables in the database that are accessible to your
+        organization. Optionally filter by schema and environment.
+
+        Args:
+          environment: Environment to query (development, staging, production)
+
+          schema: Database schema to filter tables
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            "/db/tables",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "environment": environment,
+                        "schema": schema,
+                    },
+                    table_list_params.TableListParams,
+                ),
+            ),
+            cast_to=TableListResponse,
+        )
+
+    async def get_row_count(
+        self,
+        table_name: str,
+        *,
+        environment: Literal["development", "staging", "production"] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> TableGetRowCountResponse:
+        """
+        Returns the total number of rows in the specified table for your organization.
+
+        Args:
+          environment: Environment to query
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not table_name:
+            raise ValueError(f"Expected a non-empty value for `table_name` but received {table_name!r}")
+        return await self._get(
+            f"/db/tables/{table_name}/count",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"environment": environment}, table_get_row_count_params.TableGetRowCountParams
+                ),
+            ),
+            cast_to=TableGetRowCountResponse,
+        )
+
+    async def retrieve_schema(
+        self,
+        table_name: str,
+        *,
+        environment: Literal["development", "staging", "production"] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> TableRetrieveSchemaResponse:
+        """
+        Returns detailed schema information for a specific table, including column
+        names, types, and constraints.
+
+        Args:
+          environment: Environment to query
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not table_name:
+            raise ValueError(f"Expected a non-empty value for `table_name` but received {table_name!r}")
+        return await self._get(
+            f"/db/tables/{table_name}/schema",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"environment": environment}, table_retrieve_schema_params.TableRetrieveSchemaParams
+                ),
+            ),
+            cast_to=TableRetrieveSchemaResponse,
+        )
+
+
+class TablesResourceWithRawResponse:
+    def __init__(self, tables: TablesResource) -> None:
+        self._tables = tables
+
+        self.list = to_raw_response_wrapper(
+            tables.list,
+        )
+        self.get_row_count = to_raw_response_wrapper(
+            tables.get_row_count,
+        )
+        self.retrieve_schema = to_raw_response_wrapper(
+            tables.retrieve_schema,
+        )
+
+
+class AsyncTablesResourceWithRawResponse:
+    def __init__(self, tables: AsyncTablesResource) -> None:
+        self._tables = tables
+
+        self.list = async_to_raw_response_wrapper(
+            tables.list,
+        )
+        self.get_row_count = async_to_raw_response_wrapper(
+            tables.get_row_count,
+        )
+        self.retrieve_schema = async_to_raw_response_wrapper(
+            tables.retrieve_schema,
+        )
+
+
+class TablesResourceWithStreamingResponse:
+    def __init__(self, tables: TablesResource) -> None:
+        self._tables = tables
+
+        self.list = to_streamed_response_wrapper(
+            tables.list,
+        )
+        self.get_row_count = to_streamed_response_wrapper(
+            tables.get_row_count,
+        )
+        self.retrieve_schema = to_streamed_response_wrapper(
+            tables.retrieve_schema,
+        )
+
+
+class AsyncTablesResourceWithStreamingResponse:
+    def __init__(self, tables: AsyncTablesResource) -> None:
+        self._tables = tables
+
+        self.list = async_to_streamed_response_wrapper(
+            tables.list,
+        )
+        self.get_row_count = async_to_streamed_response_wrapper(
+            tables.get_row_count,
+        )
+        self.retrieve_schema = async_to_streamed_response_wrapper(
+            tables.retrieve_schema,
+        )

worqhat/resources/flows.py

@@ -9,7 +9,7 @@ from typing_extensions import Literal
 import httpx
 
 from ..types import flow_get_metrics_params, flow_trigger_with_file_params, flow_trigger_with_payload_params
-from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, FileTypes
+from .._types import Body, Omit, Query, Headers, NotGiven, FileTypes, omit, not_given
 from .._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -50,16 +50,16 @@ class FlowsResource(SyncAPIResource):
     def get_metrics(
         self,
         *,
-        end_date: Union[str, date] | NotGiven = NOT_GIVEN,
-        start_date: Union[str, date] | NotGiven = NOT_GIVEN,
-        status: Literal["completed", "failed", "in_progress"] | NotGiven = NOT_GIVEN,
-        user_id: str | NotGiven = NOT_GIVEN,
+        end_date: Union[str, date] | Omit = omit,
+        start_date: Union[str, date] | Omit = omit,
+        status: Literal["completed", "failed", "in_progress"] | Omit = omit,
+        user_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FlowGetMetricsResponse:
         """Get metrics for workflows within a specified date range.
 
@@ -111,14 +111,14 @@ class FlowsResource(SyncAPIResource):
         self,
         flow_id: str,
         *,
-        file: FileTypes | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
+        file: FileTypes | Omit = omit,
+        url: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FlowTriggerWithFileResponse:
         """Trigger a workflow by its ID with either a file upload or a URL to a file.
 
@@ -167,13 +167,13 @@ class FlowsResource(SyncAPIResource):
         self,
         flow_id: str,
         *,
-        body: Dict[str, object],
+        data: Dict[str, object] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FlowTriggerWithPayloadResponse:
         """Trigger a workflow by its ID with a JSON payload.
 
@@ -182,6 +182,8 @@ class FlowsResource(SyncAPIResource):
         workflow ID must be specified in the URL path.
 
         Args:
+          data: Optional structured data to pass to the workflow
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -194,7 +196,7 @@ class FlowsResource(SyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `flow_id` but received {flow_id!r}")
         return self._post(
             f"/flows/trigger/{flow_id}",
-            body=maybe_transform(body, flow_trigger_with_payload_params.FlowTriggerWithPayloadParams),
+            body=maybe_transform({"data": data}, flow_trigger_with_payload_params.FlowTriggerWithPayloadParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -225,16 +227,16 @@ class AsyncFlowsResource(AsyncAPIResource):
     async def get_metrics(
         self,
         *,
-        end_date: Union[str, date] | NotGiven = NOT_GIVEN,
-        start_date: Union[str, date] | NotGiven = NOT_GIVEN,
-        status: Literal["completed", "failed", "in_progress"] | NotGiven = NOT_GIVEN,
-        user_id: str | NotGiven = NOT_GIVEN,
+        end_date: Union[str, date] | Omit = omit,
+        start_date: Union[str, date] | Omit = omit,
+        status: Literal["completed", "failed", "in_progress"] | Omit = omit,
+        user_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FlowGetMetricsResponse:
         """Get metrics for workflows within a specified date range.
 
@@ -286,14 +288,14 @@ class AsyncFlowsResource(AsyncAPIResource):
         self,
         flow_id: str,
         *,
-        file: FileTypes | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
+        file: FileTypes | Omit = omit,
+        url: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FlowTriggerWithFileResponse:
         """Trigger a workflow by its ID with either a file upload or a URL to a file.
 
@@ -342,13 +344,13 @@ class AsyncFlowsResource(AsyncAPIResource):
         self,
         flow_id: str,
         *,
-        body: Dict[str, object],
+        data: Dict[str, object] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FlowTriggerWithPayloadResponse:
         """Trigger a workflow by its ID with a JSON payload.
 
@@ -357,6 +359,8 @@ class AsyncFlowsResource(AsyncAPIResource):
         workflow ID must be specified in the URL path.
 
         Args:
+          data: Optional structured data to pass to the workflow
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -369,7 +373,9 @@ class AsyncFlowsResource(AsyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `flow_id` but received {flow_id!r}")
         return await self._post(
             f"/flows/trigger/{flow_id}",
-            body=await async_maybe_transform(body, flow_trigger_with_payload_params.FlowTriggerWithPayloadParams),
+            body=await async_maybe_transform(
+                {"data": data}, flow_trigger_with_payload_params.FlowTriggerWithPayloadParams
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

worqhat/resources/health.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import httpx
 
-from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from .._types import Body, Query, Headers, NotGiven, not_given
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -47,7 +47,7 @@ class HealthResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> HealthCheckResponse:
         """Check if the server is running and get uptime information.
 
@@ -91,7 +91,7 @@ class AsyncHealthResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> HealthCheckResponse:
         """Check if the server is running and get uptime information.