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

worqhat/resources/storage.py

@@ -0,0 +1,462 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Mapping, cast
+
+import httpx
+
+from ..types import storage_upload_file_params, storage_retrieve_file_by_path_params
+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
+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.storage_upload_file_response import StorageUploadFileResponse
+from ..types.storage_delete_file_by_id_response import StorageDeleteFileByIDResponse
+from ..types.storage_retrieve_file_by_id_response import StorageRetrieveFileByIDResponse
+from ..types.storage_retrieve_file_by_path_response import StorageRetrieveFileByPathResponse
+
+__all__ = ["StorageResource", "AsyncStorageResource"]
+
+
+class StorageResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> StorageResourceWithRawResponse:
+        """
+        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 StorageResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> StorageResourceWithStreamingResponse:
+        """
+        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 StorageResourceWithStreamingResponse(self)
+
+    def delete_file_by_id(
+        self,
+        file_id: str,
+        *,
+        # 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,
+    ) -> StorageDeleteFileByIDResponse:
+        """Permanently deletes a file from storage by its unique ID.
+
+        This action cannot be
+        undone.
+
+        Args:
+          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 file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        return self._delete(
+            f"/storage/delete/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=StorageDeleteFileByIDResponse,
+        )
+
+    def retrieve_file_by_id(
+        self,
+        file_id: str,
+        *,
+        # 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,
+    ) -> StorageRetrieveFileByIDResponse:
+        """Retrieves a file from storage by its unique ID.
+
+        Returns the file metadata and a
+        download URL.
+
+        Args:
+          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 file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        return self._get(
+            f"/storage/fetch/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=StorageRetrieveFileByIDResponse,
+        )
+
+    def retrieve_file_by_path(
+        self,
+        *,
+        filepath: str,
+        # 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,
+    ) -> StorageRetrieveFileByPathResponse:
+        """
+        Retrieves a file from storage by its path within the organization's storage.
+        Returns the file metadata and a download URL.
+
+        Args:
+          filepath: Path to the file within organization storage
+
+          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(
+            "/storage/fetch-by-path",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {"filepath": filepath}, storage_retrieve_file_by_path_params.StorageRetrieveFileByPathParams
+                ),
+            ),
+            cast_to=StorageRetrieveFileByPathResponse,
+        )
+
+    def upload_file(
+        self,
+        *,
+        file: FileTypes,
+        path: 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,
+    ) -> StorageUploadFileResponse:
+        """Uploads a file to S3 storage and returns the file ID and metadata.
+
+        Optionally
+        specify a custom path within the organization's storage bucket.
+
+        Args:
+          file: File to upload (max 50MB)
+
+          path: Optional custom path within organization storage
+
+          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
+        """
+        body = deepcopy_minimal(
+            {
+                "file": file,
+                "path": path,
+            }
+        )
+        files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
+        # It should be noted that the actual Content-Type header that will be
+        # sent to the server will contain a `boundary` parameter, e.g.
+        # multipart/form-data; boundary=---abc--
+        extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
+        return self._post(
+            "/storage/upload",
+            body=maybe_transform(body, storage_upload_file_params.StorageUploadFileParams),
+            files=files,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=StorageUploadFileResponse,
+        )
+
+
+class AsyncStorageResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncStorageResourceWithRawResponse:
+        """
+        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 AsyncStorageResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncStorageResourceWithStreamingResponse:
+        """
+        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 AsyncStorageResourceWithStreamingResponse(self)
+
+    async def delete_file_by_id(
+        self,
+        file_id: str,
+        *,
+        # 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,
+    ) -> StorageDeleteFileByIDResponse:
+        """Permanently deletes a file from storage by its unique ID.
+
+        This action cannot be
+        undone.
+
+        Args:
+          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 file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        return await self._delete(
+            f"/storage/delete/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=StorageDeleteFileByIDResponse,
+        )
+
+    async def retrieve_file_by_id(
+        self,
+        file_id: str,
+        *,
+        # 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,
+    ) -> StorageRetrieveFileByIDResponse:
+        """Retrieves a file from storage by its unique ID.
+
+        Returns the file metadata and a
+        download URL.
+
+        Args:
+          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 file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        return await self._get(
+            f"/storage/fetch/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=StorageRetrieveFileByIDResponse,
+        )
+
+    async def retrieve_file_by_path(
+        self,
+        *,
+        filepath: str,
+        # 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,
+    ) -> StorageRetrieveFileByPathResponse:
+        """
+        Retrieves a file from storage by its path within the organization's storage.
+        Returns the file metadata and a download URL.
+
+        Args:
+          filepath: Path to the file within organization storage
+
+          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(
+            "/storage/fetch-by-path",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"filepath": filepath}, storage_retrieve_file_by_path_params.StorageRetrieveFileByPathParams
+                ),
+            ),
+            cast_to=StorageRetrieveFileByPathResponse,
+        )
+
+    async def upload_file(
+        self,
+        *,
+        file: FileTypes,
+        path: 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,
+    ) -> StorageUploadFileResponse:
+        """Uploads a file to S3 storage and returns the file ID and metadata.
+
+        Optionally
+        specify a custom path within the organization's storage bucket.
+
+        Args:
+          file: File to upload (max 50MB)
+
+          path: Optional custom path within organization storage
+
+          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
+        """
+        body = deepcopy_minimal(
+            {
+                "file": file,
+                "path": path,
+            }
+        )
+        files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
+        # It should be noted that the actual Content-Type header that will be
+        # sent to the server will contain a `boundary` parameter, e.g.
+        # multipart/form-data; boundary=---abc--
+        extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
+        return await self._post(
+            "/storage/upload",
+            body=await async_maybe_transform(body, storage_upload_file_params.StorageUploadFileParams),
+            files=files,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=StorageUploadFileResponse,
+        )
+
+
+class StorageResourceWithRawResponse:
+    def __init__(self, storage: StorageResource) -> None:
+        self._storage = storage
+
+        self.delete_file_by_id = to_raw_response_wrapper(
+            storage.delete_file_by_id,
+        )
+        self.retrieve_file_by_id = to_raw_response_wrapper(
+            storage.retrieve_file_by_id,
+        )
+        self.retrieve_file_by_path = to_raw_response_wrapper(
+            storage.retrieve_file_by_path,
+        )
+        self.upload_file = to_raw_response_wrapper(
+            storage.upload_file,
+        )
+
+
+class AsyncStorageResourceWithRawResponse:
+    def __init__(self, storage: AsyncStorageResource) -> None:
+        self._storage = storage
+
+        self.delete_file_by_id = async_to_raw_response_wrapper(
+            storage.delete_file_by_id,
+        )
+        self.retrieve_file_by_id = async_to_raw_response_wrapper(
+            storage.retrieve_file_by_id,
+        )
+        self.retrieve_file_by_path = async_to_raw_response_wrapper(
+            storage.retrieve_file_by_path,
+        )
+        self.upload_file = async_to_raw_response_wrapper(
+            storage.upload_file,
+        )
+
+
+class StorageResourceWithStreamingResponse:
+    def __init__(self, storage: StorageResource) -> None:
+        self._storage = storage
+
+        self.delete_file_by_id = to_streamed_response_wrapper(
+            storage.delete_file_by_id,
+        )
+        self.retrieve_file_by_id = to_streamed_response_wrapper(
+            storage.retrieve_file_by_id,
+        )
+        self.retrieve_file_by_path = to_streamed_response_wrapper(
+            storage.retrieve_file_by_path,
+        )
+        self.upload_file = to_streamed_response_wrapper(
+            storage.upload_file,
+        )
+
+
+class AsyncStorageResourceWithStreamingResponse:
+    def __init__(self, storage: AsyncStorageResource) -> None:
+        self._storage = storage
+
+        self.delete_file_by_id = async_to_streamed_response_wrapper(
+            storage.delete_file_by_id,
+        )
+        self.retrieve_file_by_id = async_to_streamed_response_wrapper(
+            storage.retrieve_file_by_id,
+        )
+        self.retrieve_file_by_path = async_to_streamed_response_wrapper(
+            storage.retrieve_file_by_path,
+        )
+        self.upload_file = async_to_streamed_response_wrapper(
+            storage.upload_file,
+        )

worqhat/types/__init__.py

@@ -3,20 +3,30 @@
 from __future__ import annotations
 
 from .health_check_response import HealthCheckResponse as HealthCheckResponse
+from .db_execute_batch_params import DBExecuteBatchParams as DBExecuteBatchParams
 from .db_execute_query_params import DBExecuteQueryParams as DBExecuteQueryParams
 from .db_insert_record_params import DBInsertRecordParams as DBInsertRecordParams
 from .flow_get_metrics_params import FlowGetMetricsParams as FlowGetMetricsParams
 from .db_delete_records_params import DBDeleteRecordsParams as DBDeleteRecordsParams
 from .db_update_records_params import DBUpdateRecordsParams as DBUpdateRecordsParams
 from .get_server_info_response import GetServerInfoResponse as GetServerInfoResponse
+from .db_execute_batch_response import DBExecuteBatchResponse as DBExecuteBatchResponse
 from .db_execute_query_response import DBExecuteQueryResponse as DBExecuteQueryResponse
 from .db_insert_record_response import DBInsertRecordResponse as DBInsertRecordResponse
 from .flow_get_metrics_response import FlowGetMetricsResponse as FlowGetMetricsResponse
 from .db_delete_records_response import DBDeleteRecordsResponse as DBDeleteRecordsResponse
 from .db_process_nl_query_params import DBProcessNlQueryParams as DBProcessNlQueryParams
 from .db_update_records_response import DBUpdateRecordsResponse as DBUpdateRecordsResponse
+from .storage_upload_file_params import StorageUploadFileParams as StorageUploadFileParams
 from .db_process_nl_query_response import DBProcessNlQueryResponse as DBProcessNlQueryResponse
+from .storage_upload_file_response import StorageUploadFileResponse as StorageUploadFileResponse
 from .flow_trigger_with_file_params import FlowTriggerWithFileParams as FlowTriggerWithFileParams
 from .flow_trigger_with_file_response import FlowTriggerWithFileResponse as FlowTriggerWithFileResponse
 from .flow_trigger_with_payload_params import FlowTriggerWithPayloadParams as FlowTriggerWithPayloadParams
 from .flow_trigger_with_payload_response import FlowTriggerWithPayloadResponse as FlowTriggerWithPayloadResponse
+from .storage_delete_file_by_id_response import StorageDeleteFileByIDResponse as StorageDeleteFileByIDResponse
+from .storage_retrieve_file_by_id_response import StorageRetrieveFileByIDResponse as StorageRetrieveFileByIDResponse
+from .storage_retrieve_file_by_path_params import StorageRetrieveFileByPathParams as StorageRetrieveFileByPathParams
+from .storage_retrieve_file_by_path_response import (
+    StorageRetrieveFileByPathResponse as StorageRetrieveFileByPathResponse,
+)

worqhat/types/db/__init__.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .table_list_params import TableListParams as TableListParams
+from .table_list_response import TableListResponse as TableListResponse
+from .table_get_row_count_params import TableGetRowCountParams as TableGetRowCountParams
+from .table_get_row_count_response import TableGetRowCountResponse as TableGetRowCountResponse
+from .table_retrieve_schema_params import TableRetrieveSchemaParams as TableRetrieveSchemaParams
+from .table_retrieve_schema_response import TableRetrieveSchemaResponse as TableRetrieveSchemaResponse

worqhat/types/db/table_get_row_count_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["TableGetRowCountParams"]
+
+
+class TableGetRowCountParams(TypedDict, total=False):
+    environment: Literal["development", "staging", "production"]
+    """Environment to query"""

worqhat/types/db/table_get_row_count_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["TableGetRowCountResponse"]
+
+
+class TableGetRowCountResponse(BaseModel):
+    count: Optional[int] = None
+
+    success: Optional[bool] = None
+
+    table: Optional[str] = None

worqhat/types/db/table_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["TableListParams"]
+
+
+class TableListParams(TypedDict, total=False):
+    environment: Literal["development", "staging", "production"]
+    """Environment to query (development, staging, production)"""
+
+    schema: str
+    """Database schema to filter tables"""

worqhat/types/db/table_list_response.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["TableListResponse", "Table"]
+
+
+class Table(BaseModel):
+    name: Optional[str] = None
+
+    schema_: Optional[str] = FieldInfo(alias="schema", default=None)
+
+    type: Optional[str] = None
+
+
+class TableListResponse(BaseModel):
+    count: Optional[int] = None
+    """Total number of tables"""
+
+    success: Optional[bool] = None
+
+    tables: Optional[List[Table]] = None

worqhat/types/db/table_retrieve_schema_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["TableRetrieveSchemaParams"]
+
+
+class TableRetrieveSchemaParams(TypedDict, total=False):
+    environment: Literal["development", "staging", "production"]
+    """Environment to query"""

worqhat/types/db/table_retrieve_schema_response.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["TableRetrieveSchemaResponse", "Column"]
+
+
+class Column(BaseModel):
+    default: Optional[str] = None
+
+    is_primary_key: Optional[bool] = FieldInfo(alias="isPrimaryKey", default=None)
+
+    name: Optional[str] = None
+
+    nullable: Optional[bool] = None
+
+    type: Optional[str] = None
+
+
+class TableRetrieveSchemaResponse(BaseModel):
+    columns: Optional[List[Column]] = None
+
+    success: Optional[bool] = None
+
+    table: Optional[str] = None

worqhat/types/db_delete_records_params.py

@@ -2,7 +2,8 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import Dict
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["DBDeleteRecordsParams"]
 
@@ -11,5 +12,8 @@ class DBDeleteRecordsParams(TypedDict, total=False):
     table: Required[str]
     """Table name to delete from"""
 
-    where: Required[object]
+    where: Required[Dict[str, object]]
     """Where conditions"""
+
+    environment: Literal["development", "staging", "production"]
+    """Environment to delete from (development, staging, production)"""

worqhat/types/db_delete_records_response.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 
 from .._models import BaseModel
 
@@ -11,7 +11,7 @@ class DBDeleteRecordsResponse(BaseModel):
     count: Optional[int] = None
     """Number of records deleted"""
 
-    data: Optional[List[object]] = None
+    data: Optional[List[Dict[str, object]]] = None
 
     message: Optional[str] = None