scale-gp-beta 0.1.0a24__py3-none-any.whl → 0.1.0a25__py3-none-any.whl

scale_gp_beta/resources/questions.py

@@ -0,0 +1,693 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Any, cast
+from typing_extensions import Literal, overload
+
+import httpx
+
+from ..types import question_list_params, question_create_params
+from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from .._utils import required_args, maybe_transform, 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 ..pagination import SyncCursorPage, AsyncCursorPage
+from .._base_client import AsyncPaginator, make_request_options
+from ..types.question import Question
+
+__all__ = ["QuestionsResource", "AsyncQuestionsResource"]
+
+
+class QuestionsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> QuestionsResourceWithRawResponse:
+        """
+        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/scaleapi/sgp-python-beta#accessing-raw-response-data-eg-headers
+        """
+        return QuestionsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> QuestionsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/scaleapi/sgp-python-beta#with_streaming_response
+        """
+        return QuestionsResourceWithStreamingResponse(self)
+
+    @overload
+    def create(
+        self,
+        *,
+        configuration: question_create_params.CategoricalQuestionRequestConfiguration,
+        name: str,
+        prompt: str,
+        question_type: Literal["categorical"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    def create(
+        self,
+        *,
+        configuration: question_create_params.RatingQuestionRequestConfiguration,
+        name: str,
+        prompt: str,
+        question_type: Literal["rating"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    def create(
+        self,
+        *,
+        name: str,
+        prompt: str,
+        configuration: question_create_params.NumberQuestionRequestConfiguration | NotGiven = NOT_GIVEN,
+        question_type: Literal["number"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    def create(
+        self,
+        *,
+        name: str,
+        prompt: str,
+        configuration: question_create_params.FreeTextQuestionRequestConfiguration | NotGiven = NOT_GIVEN,
+        question_type: Literal["free_text"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    def create(
+        self,
+        *,
+        configuration: question_create_params.FormQuestionRequestConfiguration,
+        name: str,
+        prompt: str,
+        question_type: Literal["form"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @required_args(["configuration", "name", "prompt"], ["name", "prompt"])
+    def create(
+        self,
+        *,
+        configuration: question_create_params.CategoricalQuestionRequestConfiguration
+        | question_create_params.RatingQuestionRequestConfiguration
+        | question_create_params.NumberQuestionRequestConfiguration
+        | question_create_params.FreeTextQuestionRequestConfiguration
+        | question_create_params.FormQuestionRequestConfiguration
+        | NotGiven = NOT_GIVEN,
+        name: str,
+        prompt: str,
+        question_type: Literal["categorical"]
+        | Literal["rating"]
+        | Literal["number"]
+        | Literal["free_text"]
+        | Literal["form"]
+        | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        return cast(
+            Question,
+            self._post(
+                "/v5/questions",
+                body=maybe_transform(
+                    {
+                        "configuration": configuration,
+                        "name": name,
+                        "prompt": prompt,
+                        "question_type": question_type,
+                    },
+                    question_create_params.QuestionCreateParams,
+                ),
+                options=make_request_options(
+                    extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                ),
+                cast_to=cast(Any, Question),  # Union types cannot be passed in as arguments in the type system
+            ),
+        )
+
+    def retrieve(
+        self,
+        question_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,
+    ) -> Question:
+        """
+        Get Question
+
+        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 question_id:
+            raise ValueError(f"Expected a non-empty value for `question_id` but received {question_id!r}")
+        return cast(
+            Question,
+            self._get(
+                f"/v5/questions/{question_id}",
+                options=make_request_options(
+                    extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                ),
+                cast_to=cast(Any, Question),  # Union types cannot be passed in as arguments in the type system
+            ),
+        )
+
+    def list(
+        self,
+        *,
+        ending_before: str | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        sort_order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
+        starting_after: str | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> SyncCursorPage[Question]:
+        """
+        List Questions
+
+        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
+        """
+        return self._get_api_list(
+            "/v5/questions",
+            page=SyncCursorPage[Question],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "ending_before": ending_before,
+                        "limit": limit,
+                        "sort_order": sort_order,
+                        "starting_after": starting_after,
+                    },
+                    question_list_params.QuestionListParams,
+                ),
+            ),
+            model=cast(Any, Question),  # Union types cannot be passed in as arguments in the type system
+        )
+
+
+class AsyncQuestionsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncQuestionsResourceWithRawResponse:
+        """
+        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/scaleapi/sgp-python-beta#accessing-raw-response-data-eg-headers
+        """
+        return AsyncQuestionsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncQuestionsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/scaleapi/sgp-python-beta#with_streaming_response
+        """
+        return AsyncQuestionsResourceWithStreamingResponse(self)
+
+    @overload
+    async def create(
+        self,
+        *,
+        configuration: question_create_params.CategoricalQuestionRequestConfiguration,
+        name: str,
+        prompt: str,
+        question_type: Literal["categorical"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    async def create(
+        self,
+        *,
+        configuration: question_create_params.RatingQuestionRequestConfiguration,
+        name: str,
+        prompt: str,
+        question_type: Literal["rating"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    async def create(
+        self,
+        *,
+        name: str,
+        prompt: str,
+        configuration: question_create_params.NumberQuestionRequestConfiguration | NotGiven = NOT_GIVEN,
+        question_type: Literal["number"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    async def create(
+        self,
+        *,
+        name: str,
+        prompt: str,
+        configuration: question_create_params.FreeTextQuestionRequestConfiguration | NotGiven = NOT_GIVEN,
+        question_type: Literal["free_text"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @overload
+    async def create(
+        self,
+        *,
+        configuration: question_create_params.FormQuestionRequestConfiguration,
+        name: str,
+        prompt: str,
+        question_type: Literal["form"] | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          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
+        """
+        ...
+
+    @required_args(["configuration", "name", "prompt"], ["name", "prompt"])
+    async def create(
+        self,
+        *,
+        configuration: question_create_params.CategoricalQuestionRequestConfiguration
+        | question_create_params.RatingQuestionRequestConfiguration
+        | question_create_params.NumberQuestionRequestConfiguration
+        | question_create_params.FreeTextQuestionRequestConfiguration
+        | question_create_params.FormQuestionRequestConfiguration
+        | NotGiven = NOT_GIVEN,
+        name: str,
+        prompt: str,
+        question_type: Literal["categorical"]
+        | Literal["rating"]
+        | Literal["number"]
+        | Literal["free_text"]
+        | Literal["form"]
+        | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Question:
+        return cast(
+            Question,
+            await self._post(
+                "/v5/questions",
+                body=await async_maybe_transform(
+                    {
+                        "configuration": configuration,
+                        "name": name,
+                        "prompt": prompt,
+                        "question_type": question_type,
+                    },
+                    question_create_params.QuestionCreateParams,
+                ),
+                options=make_request_options(
+                    extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                ),
+                cast_to=cast(Any, Question),  # Union types cannot be passed in as arguments in the type system
+            ),
+        )
+
+    async def retrieve(
+        self,
+        question_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,
+    ) -> Question:
+        """
+        Get Question
+
+        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 question_id:
+            raise ValueError(f"Expected a non-empty value for `question_id` but received {question_id!r}")
+        return cast(
+            Question,
+            await self._get(
+                f"/v5/questions/{question_id}",
+                options=make_request_options(
+                    extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                ),
+                cast_to=cast(Any, Question),  # Union types cannot be passed in as arguments in the type system
+            ),
+        )
+
+    def list(
+        self,
+        *,
+        ending_before: str | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        sort_order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
+        starting_after: str | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> AsyncPaginator[Question, AsyncCursorPage[Question]]:
+        """
+        List Questions
+
+        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
+        """
+        return self._get_api_list(
+            "/v5/questions",
+            page=AsyncCursorPage[Question],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "ending_before": ending_before,
+                        "limit": limit,
+                        "sort_order": sort_order,
+                        "starting_after": starting_after,
+                    },
+                    question_list_params.QuestionListParams,
+                ),
+            ),
+            model=cast(Any, Question),  # Union types cannot be passed in as arguments in the type system
+        )
+
+
+class QuestionsResourceWithRawResponse:
+    def __init__(self, questions: QuestionsResource) -> None:
+        self._questions = questions
+
+        self.create = to_raw_response_wrapper(
+            questions.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            questions.retrieve,
+        )
+        self.list = to_raw_response_wrapper(
+            questions.list,
+        )
+
+
+class AsyncQuestionsResourceWithRawResponse:
+    def __init__(self, questions: AsyncQuestionsResource) -> None:
+        self._questions = questions
+
+        self.create = async_to_raw_response_wrapper(
+            questions.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            questions.retrieve,
+        )
+        self.list = async_to_raw_response_wrapper(
+            questions.list,
+        )
+
+
+class QuestionsResourceWithStreamingResponse:
+    def __init__(self, questions: QuestionsResource) -> None:
+        self._questions = questions
+
+        self.create = to_streamed_response_wrapper(
+            questions.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            questions.retrieve,
+        )
+        self.list = to_streamed_response_wrapper(
+            questions.list,
+        )
+
+
+class AsyncQuestionsResourceWithStreamingResponse:
+    def __init__(self, questions: AsyncQuestionsResource) -> None:
+        self._questions = questions
+
+        self.create = async_to_streamed_response_wrapper(
+            questions.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            questions.retrieve,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            questions.list,
+        )