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

payi/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "payi"
-__version__ = "0.1.0-alpha.58"  # x-release-please-version
+__version__ = "0.1.0-alpha.60"  # x-release-please-version

payi/lib/instrument.py

@@ -25,10 +25,22 @@ class Context(TypedDict, total=False):
     proxy: bool
     experience_name: Optional[str]
     experience_id: Optional[str]
+    use_case_name: Optional[str]
+    use_case_id: Optional[str]
+    use_case_version: Optional[int]
     limit_ids: Optional['list[str]']
     request_tags: Optional['list[str]']
     user_id: Optional[str]
 
+class ParentState(TypedDict, total=False):
+    experience_name: Optional[str]
+    experience_id: Optional[str]
+    use_case_name: Optional[str]
+    use_case_id: Optional[str]
+    use_case_version: Optional[int]
+    limit_ids: Optional['list[str]']
+    request_tags: Optional['list[str]']
+
 class IsStreaming(Enum):
     false = 0
     true = 1 
@@ -221,40 +233,51 @@ class PayiInstrumentor:
 
     def _setup_call_func(
         self
-        ) -> 'tuple[Context, Optional[str], Optional[str]]':
+        ) -> 'tuple[Context, ParentState]':
         context: Context = {}
+        parentState: ParentState = {}
 
         if len(self._context_stack) > 0:
             # copy current context into the upcoming context
             context = self._context_stack[-1].copy()
             context.pop("proxy")
-            previous_experience_name = context.get("experience_name", None)
-            previous_experience_id = context.get("experience_id", None)
-        else:
-            previous_experience_name = None
-            previous_experience_id = None
-        return (context, previous_experience_name, previous_experience_id)
+            parentState["experience_name"] = context.get("experience_name", None)
+            parentState["experience_id"] = context.get("experience_id", None)
+            parentState["use_case_name"] = context.get("use_case_name", None)
+            parentState["use_case_id"] = context.get("use_case_id", None)
+            parentState["use_case_version"] = context.get("use_case_version", None)
+            parentState["limit_ids"] = context.get("limit_ids", None)
+            parentState["request_tags"] = context.get("request_tags", None)
+
+        return (context, parentState)
 
     def _init_context(
         self,
         context: Context,
-        previous_experience_name: Optional[str],
-        previous_experience_id: Optional[str],
+        parentState: ParentState,
         proxy: bool,
         limit_ids: Optional["list[str]"],
         request_tags: Optional["list[str]"],
         experience_name: Optional[str],
         experience_id: Optional[str],
+        use_case_name: Optional[str],
+        use_case_id: Optional[str],
+        use_case_version: Optional[int],                
         user_id: Optional[str],
         ) -> None:
         context["proxy"] = proxy
 
+        # TODO use case what if caller specified epxerience / use_case ID and no name?
+
         # Handle experience name and ID logic
         if not experience_name:
             # If no experience_name specified, use previous values
-            context["experience_name"] = previous_experience_name
-            context["experience_id"] = previous_experience_id
+            context["experience_name"] = parentState.get("experience_name", None)
+            context["experience_id"] = parentState.get("experience_id", None)
         else:
+            previous_experience_name = parentState.get("experience_name", None)
+            previous_experience_id = parentState.get("experience_id", None)
+
             # If experience_name is specified
             if experience_name == previous_experience_name:
                 # Same experience name, use previous ID unless new one specified
@@ -265,6 +288,29 @@ class PayiInstrumentor:
                 context["experience_name"] = experience_name
                 context["experience_id"] = experience_id if experience_id else str(uuid.uuid4())
 
+        # Handle use case name and ID logic
+        if not use_case_name: # TODO use case
+            # If no use_case_name specified, use previous values
+            context["use_case_name"] = parentState.get("use_case_name", None)
+            context["use_case_id"] = parentState.get("use_case_id", None)
+            context["use_case_version"] = parentState.get("use_case_version", None)
+        else:
+            previous_use_case_name = parentState.get("use_case_name", None)
+            previous_use_case_id = parentState.get("use_case_id", None)
+            previous_use_case_version = parentState.get("use_case_version", None)
+
+            # If use_case_name is specified
+            if use_case_name == previous_use_case_name:
+                # Same use case name, use previous ID unless new one specified
+                context["use_case_name"] = use_case_name
+                context["use_case_id"] = use_case_id if use_case_id else previous_use_case_id
+                context["use_case_version"] = use_case_version if use_case_version else previous_use_case_version
+            else:
+                # Different experience name, use specified ID or generate one
+                context["use_case_name"] = use_case_name
+                context["use_case_id"] = use_case_id if use_case_id else str(uuid.uuid4())
+                context["use_case_version"] = use_case_version
+
         # set any values explicitly passed by the caller, otherwise use what is already in the context
         if limit_ids:
             context["limit_ids"] = limit_ids
@@ -283,22 +329,27 @@ class PayiInstrumentor:
         request_tags: Optional["list[str]"],
         experience_name: Optional[str],
         experience_id: Optional[str],
+        use_case_name: Optional[str],
+        use_case_id: Optional[str],
+        use_case_version: Optional[int],        
         user_id: Optional[str],
         *args: Any,
         **kwargs: Any,
     ) -> Any:
-        context, previous_experience_name, previous_experience_id = self._setup_call_func()
+        context, parentState = self._setup_call_func()
 
         with self:
             self._init_context(
                 context,
-                previous_experience_name,
-                previous_experience_id,
+                parentState,
                 proxy, 
                 limit_ids, 
                 request_tags,
                 experience_name,
                 experience_id,
+                use_case_name,
+                use_case_id,
+                use_case_version,
                 user_id)
             return await func(*args, **kwargs)
 
@@ -310,22 +361,27 @@ class PayiInstrumentor:
         request_tags: Optional["list[str]"],
         experience_name: Optional[str],
         experience_id: Optional[str],
+        use_case_name: Optional[str],
+        use_case_id: Optional[str],
+        use_case_version: Optional[int],        
         user_id: Optional[str],
         *args: Any,
         **kwargs: Any,
     ) -> Any:
-        context, previous_experience_name, previous_experience_id = self._setup_call_func()
+        context, parentState = self._setup_call_func()
 
         with self:
             self._init_context(
                 context,
-                previous_experience_name,
-                previous_experience_id,
+                parentState,
                 proxy, 
                 limit_ids, 
                 request_tags,
                 experience_name,
                 experience_id,
+                use_case_name,
+                use_case_id,
+                use_case_version,
                 user_id)
             return func(*args, **kwargs)
 
@@ -348,7 +404,6 @@ class PayiInstrumentor:
         # Return the current top of the stack
         return self._context_stack[-1] if self._context_stack else None
 
-
     def _prepare_ingest(
         self,
         ingest: IngestUnitsParams,
@@ -359,6 +414,9 @@ class PayiInstrumentor:
         request_tags = ingest_extra_headers.pop(PayiHeaderNames.request_tags, None)
         experience_name = ingest_extra_headers.pop(PayiHeaderNames.experience_name, None)
         experience_id = ingest_extra_headers.pop(PayiHeaderNames.experience_id, None)
+        use_case_name = ingest_extra_headers.pop(PayiHeaderNames.use_case_name, None)
+        use_case_id = ingest_extra_headers.pop(PayiHeaderNames.use_case_id, None)
+        use_case_version = ingest_extra_headers.pop(PayiHeaderNames.use_case_version, None)
         user_id = ingest_extra_headers.pop(PayiHeaderNames.user_id, None)
 
         if limit_ids:
@@ -369,6 +427,12 @@ class PayiInstrumentor:
             ingest["experience_name"] = experience_name
         if experience_id:
             ingest["experience_id"] = experience_id
+        if use_case_name:
+            ingest["use_case_name"] = use_case_name
+        if use_case_id:
+            ingest["use_case_id"] = use_case_id
+        if use_case_version:
+            ingest["use_case_version"] = int(use_case_version)
         if user_id:
             ingest["user_id"] = user_id
 
@@ -656,6 +720,9 @@ class PayiInstrumentor:
         request_tags: Optional[list[str]] = context.get("request_tags")
         experience_name: Optional[str] = context.get("experience_name")
         experience_id: Optional[str] = context.get("experience_id")
+        use_case_name: Optional[str] = context.get("use_case_name")
+        use_case_id: Optional[str] = context.get("use_case_id")
+        use_case_version: Optional[int] = context.get("use_case_version")
         user_id: Optional[str] = context.get("user_id")
 
         # Merge limits from the decorator and extra headers
@@ -703,6 +770,31 @@ class PayiInstrumentor:
             # use the inner experience name and id as-is
             ...
 
+        # inner extra_headers use_casee_name and use_case_id take precedence over outer decorator use_case_name and use_case_id
+        # if either inner value is specified, ignore outer decorator values
+        if PayiHeaderNames.use_case_name not in extra_headers and PayiHeaderNames.use_case_id not in extra_headers:
+
+            # use decorator values
+            if use_case_name is not None:
+                extra_headers[PayiHeaderNames.use_case_name] = use_case_name
+            if use_case_id is not None:
+                extra_headers[PayiHeaderNames.use_case_id] = use_case_id
+            if use_case_version is not None:
+                extra_headers[PayiHeaderNames.use_case_version] = str(use_case_version)
+        
+        elif PayiHeaderNames.use_case_id in extra_headers and PayiHeaderNames.use_case_name not in extra_headers:
+            # use the decorator experience name and the inner experience id
+            if use_case_name is not None:
+                extra_headers[PayiHeaderNames.use_case_name] = use_case_name
+            
+            # use the decorator experience version and the inner experience id
+            if use_case_version is not None:
+                extra_headers[PayiHeaderNames.use_case_version] = str(use_case_version) # TODO use case 
+        
+        else:
+            # use the inner experience name and id as-is
+            ...
+
     @staticmethod
     def update_for_vision(input: int, units: 'dict[str, Units]') -> int:
         if PayiInstrumentor.estimated_prompt_tokens in units:
@@ -926,6 +1018,9 @@ def ingest(
     request_tags: Optional["list[str]"] = None,
     experience_name: Optional[str] = None,
     experience_id: Optional[str] = None,
+    use_case_name: Optional[str] = None,
+    use_case_id: Optional[str] = None,
+    use_case_version: Optional[int] = None,
     user_id: Optional[str] = None,
 ) -> Any:
     def _ingest(func: Any) -> Any:
@@ -942,6 +1037,9 @@ def ingest(
                     request_tags,
                     experience_name,
                     experience_id,
+                    use_case_name,
+                    use_case_id,
+                    use_case_version,
                     user_id,
                     *args,
                     **kwargs,
@@ -958,6 +1056,9 @@ def ingest(
                     request_tags,
                     experience_name,
                     experience_id,
+                    use_case_name,
+                    use_case_id,
+                    use_case_version,
                     user_id,
                     *args,
                     **kwargs,
@@ -970,6 +1071,9 @@ def proxy(
     request_tags: Optional["list[str]"] = None,
     experience_name: Optional[str] = None,
     experience_id: Optional[str] = None,
+    use_case_id: Optional[str] = None,
+    use_case_name: Optional[str] = None,
+    use_case_version: Optional[int] = None,
     user_id: Optional[str] = None,
 ) -> Any:
     def _proxy(func: Any) -> Any:
@@ -985,6 +1089,9 @@ def proxy(
                     request_tags,
                     experience_name,
                     experience_id,
+                    use_case_name,
+                    use_case_id,
+                    use_case_version,
                     user_id,
                     *args,
                     **kwargs
@@ -1002,6 +1109,9 @@ def proxy(
                     request_tags,
                     experience_name,
                     experience_id,
+                    use_case_name,
+                    use_case_id,
+                    use_case_version,
                     user_id,
                     *args,
                     **kwargs

payi/pagination.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Generic, TypeVar, Optional
+from typing_extensions import override
+
+from ._base_client import BasePage, PageInfo, BaseSyncPage, BaseAsyncPage
+
+__all__ = ["SyncCursorPage", "AsyncCursorPage"]
+
+_T = TypeVar("_T")
+
+
+class SyncCursorPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
+    items: List[_T]
+    cursor: Optional[str] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        items = self.items
+        if not items:
+            return []
+        return items
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        cursor = self.cursor
+        if not cursor:
+            return None
+
+        return PageInfo(params={"cursor": cursor})
+
+
+class AsyncCursorPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]):
+    items: List[_T]
+    cursor: Optional[str] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        items = self.items
+        if not items:
+            return []
+        return items
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        cursor = self.cursor
+        if not cursor:
+            return None
+
+        return PageInfo(params={"cursor": cursor})

payi/resources/categories/categories.py

@@ -4,7 +4,9 @@ from __future__ import annotations
 
 import httpx
 
+from ...types import category_list_params, category_list_resources_params
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import maybe_transform
 from ..._compat import cached_property
 from .resources import (
     ResourcesResource,
@@ -21,10 +23,11 @@ from ..._response import (
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ..._base_client import make_request_options
-from ...types.category_list_response import CategoryListResponse
+from ...pagination import SyncCursorPage, AsyncCursorPage
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.category_response import CategoryResponse
 from ...types.category_delete_response import CategoryDeleteResponse
-from ...types.category_list_resources_response import CategoryListResourcesResponse
+from ...types.category_resource_response import CategoryResourceResponse
 from ...types.category_delete_resource_response import CategoryDeleteResourceResponse
 
 __all__ = ["CategoriesResource", "AsyncCategoriesResource"]
@@ -57,20 +60,46 @@ class CategoriesResource(SyncAPIResource):
     def list(
         self,
         *,
+        cursor: 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,
-    ) -> CategoryListResponse:
-        """Get all Categories"""
-        return self._get(
+    ) -> SyncCursorPage[CategoryResponse]:
+        """
+        Get all Categories
+
+        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(
             "/api/v1/categories",
+            page=SyncCursorPage[CategoryResponse],
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "limit": limit,
+                        "sort_ascending": sort_ascending,
+                    },
+                    category_list_params.CategoryListParams,
+                ),
             ),
-            cast_to=CategoryListResponse,
+            model=CategoryResponse,
         )
 
     def delete(
@@ -146,13 +175,16 @@ class CategoriesResource(SyncAPIResource):
         self,
         category: str,
         *,
+        cursor: 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,
-    ) -> CategoryListResourcesResponse:
+    ) -> SyncCursorPage[CategoryResourceResponse]:
         """
         Get all Resources for a Category
 
@@ -167,12 +199,24 @@ class CategoriesResource(SyncAPIResource):
         """
         if not category:
             raise ValueError(f"Expected a non-empty value for `category` but received {category!r}")
-        return self._get(
+        return self._get_api_list(
             f"/api/v1/categories/{category}/resources",
+            page=SyncCursorPage[CategoryResourceResponse],
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "limit": limit,
+                        "sort_ascending": sort_ascending,
+                    },
+                    category_list_resources_params.CategoryListResourcesParams,
+                ),
             ),
-            cast_to=CategoryListResourcesResponse,
+            model=CategoryResourceResponse,
         )
 
 
@@ -200,23 +244,49 @@ class AsyncCategoriesResource(AsyncAPIResource):
         """
         return AsyncCategoriesResourceWithStreamingResponse(self)
 
-    async def list(
+    def list(
         self,
         *,
+        cursor: 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,
-    ) -> CategoryListResponse:
-        """Get all Categories"""
-        return await self._get(
+    ) -> AsyncPaginator[CategoryResponse, AsyncCursorPage[CategoryResponse]]:
+        """
+        Get all Categories
+
+        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(
             "/api/v1/categories",
+            page=AsyncCursorPage[CategoryResponse],
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "limit": limit,
+                        "sort_ascending": sort_ascending,
+                    },
+                    category_list_params.CategoryListParams,
+                ),
             ),
-            cast_to=CategoryListResponse,
+            model=CategoryResponse,
         )
 
     async def delete(
@@ -288,17 +358,20 @@ class AsyncCategoriesResource(AsyncAPIResource):
             cast_to=CategoryDeleteResourceResponse,
         )
 
-    async def list_resources(
+    def list_resources(
         self,
         category: str,
         *,
+        cursor: 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,
-    ) -> CategoryListResourcesResponse:
+    ) -> AsyncPaginator[CategoryResourceResponse, AsyncCursorPage[CategoryResourceResponse]]:
         """
         Get all Resources for a Category
 
@@ -313,12 +386,24 @@ class AsyncCategoriesResource(AsyncAPIResource):
         """
         if not category:
             raise ValueError(f"Expected a non-empty value for `category` but received {category!r}")
-        return await self._get(
+        return self._get_api_list(
             f"/api/v1/categories/{category}/resources",
+            page=AsyncCursorPage[CategoryResourceResponse],
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "limit": limit,
+                        "sort_ascending": sort_ascending,
+                    },
+                    category_list_resources_params.CategoryListResourcesParams,
+                ),
             ),
-            cast_to=CategoryListResourcesResponse,
+            model=CategoryResourceResponse,
         )