payi 0.1.0a59__py3-none-any.whl → 0.1.0a60__py3-none-any.whl

payi/resources/use_cases/definitions/kpis.py

@@ -0,0 +1,584 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal
+
+import httpx
+
+from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ...._utils import (
+    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.use_cases.definitions import kpi_list_params, kpi_create_params, kpi_update_params
+from ....types.use_cases.definitions.kpi_list_response import KpiListResponse
+from ....types.use_cases.definitions.kpi_create_response import KpiCreateResponse
+from ....types.use_cases.definitions.kpi_delete_response import KpiDeleteResponse
+from ....types.use_cases.definitions.kpi_update_response import KpiUpdateResponse
+from ....types.use_cases.definitions.kpi_retrieve_response import KpiRetrieveResponse
+
+__all__ = ["KpisResource", "AsyncKpisResource"]
+
+
+class KpisResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> KpisResourceWithRawResponse:
+        """
+        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/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
+        """
+        return KpisResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> KpisResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#with_streaming_response
+        """
+        return KpisResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        use_case_name: str,
+        *,
+        description: str,
+        name: str,
+        goal: float | NotGiven = NOT_GIVEN,
+        kpi_type: Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"] | 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,
+    ) -> KpiCreateResponse:
+        """
+        Create a new Use Case KPI definition
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        return self._post(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                    "goal": goal,
+                    "kpi_type": kpi_type,
+                },
+                kpi_create_params.KpiCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiCreateResponse,
+        )
+
+    def retrieve(
+        self,
+        kpi_name: str,
+        *,
+        use_case_name: 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,
+    ) -> KpiRetrieveResponse:
+        """
+        Get a KPI definition for a Use Case
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        if not kpi_name:
+            raise ValueError(f"Expected a non-empty value for `kpi_name` but received {kpi_name!r}")
+        return self._get(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiRetrieveResponse,
+        )
+
+    def update(
+        self,
+        kpi_name: str,
+        *,
+        use_case_name: str,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        goal: Optional[float] | 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,
+    ) -> KpiUpdateResponse:
+        """
+        Update a Use Case KPI definition
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        if not kpi_name:
+            raise ValueError(f"Expected a non-empty value for `kpi_name` but received {kpi_name!r}")
+        return self._put(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "goal": goal,
+                },
+                kpi_update_params.KpiUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiUpdateResponse,
+        )
+
+    def list(
+        self,
+        use_case_name: str,
+        *,
+        cursor: str | NotGiven = NOT_GIVEN,
+        kpi_name: str | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        sort_ascending: bool | 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[KpiListResponse]:
+        """
+        Get all KPIs for a Use Case
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        return self._get_api_list(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis",
+            page=SyncCursorPage[KpiListResponse],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "kpi_name": kpi_name,
+                        "limit": limit,
+                        "sort_ascending": sort_ascending,
+                    },
+                    kpi_list_params.KpiListParams,
+                ),
+            ),
+            model=KpiListResponse,
+        )
+
+    def delete(
+        self,
+        kpi_name: str,
+        *,
+        use_case_name: 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,
+    ) -> KpiDeleteResponse:
+        """
+        Delete a Use Case KPI definition
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        if not kpi_name:
+            raise ValueError(f"Expected a non-empty value for `kpi_name` but received {kpi_name!r}")
+        return self._delete(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiDeleteResponse,
+        )
+
+
+class AsyncKpisResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncKpisResourceWithRawResponse:
+        """
+        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/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncKpisResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncKpisResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#with_streaming_response
+        """
+        return AsyncKpisResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        use_case_name: str,
+        *,
+        description: str,
+        name: str,
+        goal: float | NotGiven = NOT_GIVEN,
+        kpi_type: Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"] | 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,
+    ) -> KpiCreateResponse:
+        """
+        Create a new Use Case KPI definition
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        return await self._post(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                    "goal": goal,
+                    "kpi_type": kpi_type,
+                },
+                kpi_create_params.KpiCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiCreateResponse,
+        )
+
+    async def retrieve(
+        self,
+        kpi_name: str,
+        *,
+        use_case_name: 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,
+    ) -> KpiRetrieveResponse:
+        """
+        Get a KPI definition for a Use Case
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        if not kpi_name:
+            raise ValueError(f"Expected a non-empty value for `kpi_name` but received {kpi_name!r}")
+        return await self._get(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiRetrieveResponse,
+        )
+
+    async def update(
+        self,
+        kpi_name: str,
+        *,
+        use_case_name: str,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        goal: Optional[float] | 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,
+    ) -> KpiUpdateResponse:
+        """
+        Update a Use Case KPI definition
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        if not kpi_name:
+            raise ValueError(f"Expected a non-empty value for `kpi_name` but received {kpi_name!r}")
+        return await self._put(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "goal": goal,
+                },
+                kpi_update_params.KpiUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiUpdateResponse,
+        )
+
+    def list(
+        self,
+        use_case_name: str,
+        *,
+        cursor: str | NotGiven = NOT_GIVEN,
+        kpi_name: str | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        sort_ascending: bool | 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[KpiListResponse, AsyncCursorPage[KpiListResponse]]:
+        """
+        Get all KPIs for a Use Case
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        return self._get_api_list(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis",
+            page=AsyncCursorPage[KpiListResponse],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "kpi_name": kpi_name,
+                        "limit": limit,
+                        "sort_ascending": sort_ascending,
+                    },
+                    kpi_list_params.KpiListParams,
+                ),
+            ),
+            model=KpiListResponse,
+        )
+
+    async def delete(
+        self,
+        kpi_name: str,
+        *,
+        use_case_name: 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,
+    ) -> KpiDeleteResponse:
+        """
+        Delete a Use Case KPI definition
+
+        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 use_case_name:
+            raise ValueError(f"Expected a non-empty value for `use_case_name` but received {use_case_name!r}")
+        if not kpi_name:
+            raise ValueError(f"Expected a non-empty value for `kpi_name` but received {kpi_name!r}")
+        return await self._delete(
+            f"/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=KpiDeleteResponse,
+        )
+
+
+class KpisResourceWithRawResponse:
+    def __init__(self, kpis: KpisResource) -> None:
+        self._kpis = kpis
+
+        self.create = to_raw_response_wrapper(
+            kpis.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            kpis.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            kpis.update,
+        )
+        self.list = to_raw_response_wrapper(
+            kpis.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            kpis.delete,
+        )
+
+
+class AsyncKpisResourceWithRawResponse:
+    def __init__(self, kpis: AsyncKpisResource) -> None:
+        self._kpis = kpis
+
+        self.create = async_to_raw_response_wrapper(
+            kpis.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            kpis.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            kpis.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            kpis.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            kpis.delete,
+        )
+
+
+class KpisResourceWithStreamingResponse:
+    def __init__(self, kpis: KpisResource) -> None:
+        self._kpis = kpis
+
+        self.create = to_streamed_response_wrapper(
+            kpis.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            kpis.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            kpis.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            kpis.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            kpis.delete,
+        )
+
+
+class AsyncKpisResourceWithStreamingResponse:
+    def __init__(self, kpis: AsyncKpisResource) -> None:
+        self._kpis = kpis
+
+        self.create = async_to_streamed_response_wrapper(
+            kpis.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            kpis.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            kpis.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            kpis.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            kpis.delete,
+        )