studyfetch-sdk 0.1.0a1__py3-none-any.whl

studyfetch_sdk/resources/v1/explainers.py

@@ -0,0 +1,216 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ..._utils import maybe_transform, async_maybe_transform
+from ..._compat import cached_property
+from ...types.v1 import explainer_handle_webhook_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
+
+__all__ = ["ExplainersResource", "AsyncExplainersResource"]
+
+
+class ExplainersResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ExplainersResourceWithRawResponse:
+        """
+        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/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return ExplainersResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ExplainersResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
+        """
+        return ExplainersResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        # 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,
+    ) -> None:
+        """Create explainers component"""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._post(
+            "/api/v1/explainers/create",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def handle_webhook(
+        self,
+        *,
+        body: 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,
+    ) -> None:
+        """
+        Handle webhook events
+
+        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
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._post(
+            "/api/v1/explainers/webhook",
+            body=maybe_transform(body, explainer_handle_webhook_params.ExplainerHandleWebhookParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncExplainersResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncExplainersResourceWithRawResponse:
+        """
+        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/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncExplainersResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncExplainersResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
+        """
+        return AsyncExplainersResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        # 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,
+    ) -> None:
+        """Create explainers component"""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._post(
+            "/api/v1/explainers/create",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def handle_webhook(
+        self,
+        *,
+        body: 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,
+    ) -> None:
+        """
+        Handle webhook events
+
+        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
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._post(
+            "/api/v1/explainers/webhook",
+            body=await async_maybe_transform(body, explainer_handle_webhook_params.ExplainerHandleWebhookParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class ExplainersResourceWithRawResponse:
+    def __init__(self, explainers: ExplainersResource) -> None:
+        self._explainers = explainers
+
+        self.create = to_raw_response_wrapper(
+            explainers.create,
+        )
+        self.handle_webhook = to_raw_response_wrapper(
+            explainers.handle_webhook,
+        )
+
+
+class AsyncExplainersResourceWithRawResponse:
+    def __init__(self, explainers: AsyncExplainersResource) -> None:
+        self._explainers = explainers
+
+        self.create = async_to_raw_response_wrapper(
+            explainers.create,
+        )
+        self.handle_webhook = async_to_raw_response_wrapper(
+            explainers.handle_webhook,
+        )
+
+
+class ExplainersResourceWithStreamingResponse:
+    def __init__(self, explainers: ExplainersResource) -> None:
+        self._explainers = explainers
+
+        self.create = to_streamed_response_wrapper(
+            explainers.create,
+        )
+        self.handle_webhook = to_streamed_response_wrapper(
+            explainers.handle_webhook,
+        )
+
+
+class AsyncExplainersResourceWithStreamingResponse:
+    def __init__(self, explainers: AsyncExplainersResource) -> None:
+        self._explainers = explainers
+
+        self.create = async_to_streamed_response_wrapper(
+            explainers.create,
+        )
+        self.handle_webhook = async_to_streamed_response_wrapper(
+            explainers.handle_webhook,
+        )