payi 0.1.0a106__tar.gz → 0.1.0a108__tar.gz

payi-0.1.0a108/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.108"
+}

{payi-0.1.0a106 → payi-0.1.0a108}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.1.0-alpha.108 (2025-08-05)
+
+Full Changelog: [v0.1.0-alpha.107...v0.1.0-alpha.108](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.107...v0.1.0-alpha.108)
+
+### Features
+
+* account_name ([#352](https://github.com/Pay-i/pay-i-python/issues/352)) ([719e871](https://github.com/Pay-i/pay-i-python/commit/719e871927187e2bce511d637144fd99a59b7234))
+
+## 0.1.0-alpha.107 (2025-07-31)
+
+Full Changelog: [v0.1.0-alpha.106...v0.1.0-alpha.107](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.106...v0.1.0-alpha.107)
+
+### Features
+
+* **api:** manual updates ([d348443](https://github.com/Pay-i/pay-i-python/commit/d3484438517ab70577dea7d77abfe9864a5678aa))
+* **client:** support file upload requests ([5019812](https://github.com/Pay-i/pay-i-python/commit/501981286bb2996403bcf0415542325d7efb8d2f))
+
 ## 0.1.0-alpha.106 (2025-07-30)
 
 Full Changelog: [v0.1.0-alpha.105...v0.1.0-alpha.106](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.105...v0.1.0-alpha.106)

{payi-0.1.0a106 → payi-0.1.0a108}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a106
+Version: 0.1.0a108
 Summary: The official Python library for the payi API
 Project-URL: Homepage, https://github.com/Pay-i/pay-i-python
 Project-URL: Repository, https://github.com/Pay-i/pay-i-python

{payi-0.1.0a106 → payi-0.1.0a108}/api.md

@@ -119,14 +119,14 @@ Methods:
 Types:
 
 ```python
-from payi.types import UseCaseCreateResponse, UseCaseRetrieveResponse, UseCaseDeleteResponse
+from payi.types import UseCaseInstanceResponse
 ```
 
 Methods:
 
-- <code title="post /api/v1/use_cases/instances/{use_case_name}">client.use_cases.<a href="./src/payi/resources/use_cases/use_cases.py">create</a>(use_case_name) -> <a href="./src/payi/types/use_case_create_response.py">UseCaseCreateResponse</a></code>
-- <code title="get /api/v1/use_cases/instances/{use_case_id}">client.use_cases.<a href="./src/payi/resources/use_cases/use_cases.py">retrieve</a>(use_case_id) -> <a href="./src/payi/types/use_case_retrieve_response.py">UseCaseRetrieveResponse</a></code>
-- <code title="delete /api/v1/use_cases/instances/{use_case_id}">client.use_cases.<a href="./src/payi/resources/use_cases/use_cases.py">delete</a>(use_case_id) -> <a href="./src/payi/types/use_case_delete_response.py">UseCaseDeleteResponse</a></code>
+- <code title="post /api/v1/use_cases/instances/{use_case_name}">client.use_cases.<a href="./src/payi/resources/use_cases/use_cases.py">create</a>(use_case_name) -> <a href="./src/payi/types/use_case_instance_response.py">UseCaseInstanceResponse</a></code>
+- <code title="get /api/v1/use_cases/instances/{use_case_id}">client.use_cases.<a href="./src/payi/resources/use_cases/use_cases.py">retrieve</a>(use_case_id) -> <a href="./src/payi/types/use_case_instance_response.py">UseCaseInstanceResponse</a></code>
+- <code title="delete /api/v1/use_cases/instances/{use_case_id}">client.use_cases.<a href="./src/payi/resources/use_cases/use_cases.py">delete</a>(use_case_id) -> <a href="./src/payi/types/use_case_instance_response.py">UseCaseInstanceResponse</a></code>
 
 ## Kpis
 
@@ -194,12 +194,6 @@ Methods:
 
 ## Properties
 
-Types:
-
-```python
-from payi.types.use_cases import PropertyCreateResponse
-```
-
 Methods:
 
 - <code title="put /api/v1/use_cases/instances/{use_case_id}/properties">client.use_cases.properties.<a href="./src/payi/resources/use_cases/properties.py">update</a>(use_case_id, \*\*<a href="src/payi/types/use_cases/property_update_params.py">params</a>) -> <a href="./src/payi/types/use_case_instance_response.py">UseCaseInstanceResponse</a></code>

{payi-0.1.0a106 → payi-0.1.0a108}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "payi"
-version = "0.1.0-alpha.106"
+version = "0.1.0-alpha.108"
 description = "The official Python library for the payi API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{payi-0.1.0a106 → payi-0.1.0a108}/requirements-dev.lock

@@ -64,6 +64,7 @@ httpx-aiohttp==0.1.8
 idna==3.4
     # via anyio
     # via httpx
+    # via requests
     # via yarl
 importlib-metadata==7.0.0
 iniconfig==2.0.0

{payi-0.1.0a106 → payi-0.1.0a108}/requirements.lock

@@ -51,15 +51,16 @@ httpx-aiohttp==0.1.8
 idna==3.4
     # via anyio
     # via httpx
+    # via requests
     # via yarl
 multidict==6.4.4
     # via aiohttp
     # via yarl
+nest-asyncio==1.6.0
+    # via payi
 propcache==0.3.1
     # via aiohttp
     # via yarl
-nest-asyncio==1.6.0
-    # via payi
 pydantic==2.10.3
     # via payi
 pydantic-core==2.27.1

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/_base_client.py

@@ -532,7 +532,10 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
         is_body_allowed = options.method.lower() != "get"
 
         if is_body_allowed:
-            kwargs["json"] = json_data if is_given(json_data) else None
+            if isinstance(json_data, bytes):
+                kwargs["content"] = json_data
+            else:
+                kwargs["json"] = json_data if is_given(json_data) else None
             kwargs["files"] = files
         else:
             headers.pop("Content-Type", None)

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/_files.py

@@ -69,12 +69,12 @@ def _transform_file(file: FileTypes) -> HttpxFileTypes:
         return file
 
     if is_tuple_t(file):
-        return (file[0], _read_file_content(file[1]), *file[2:])
+        return (file[0], read_file_content(file[1]), *file[2:])
 
     raise TypeError(f"Expected file types input to be a FileContent type or to be a tuple")
 
 
-def _read_file_content(file: FileContent) -> HttpxFileContent:
+def read_file_content(file: FileContent) -> HttpxFileContent:
     if isinstance(file, os.PathLike):
         return pathlib.Path(file).read_bytes()
     return file
@@ -111,12 +111,12 @@ async def _async_transform_file(file: FileTypes) -> HttpxFileTypes:
         return file
 
     if is_tuple_t(file):
-        return (file[0], await _async_read_file_content(file[1]), *file[2:])
+        return (file[0], await async_read_file_content(file[1]), *file[2:])
 
     raise TypeError(f"Expected file types input to be a FileContent type or to be a tuple")
 
 
-async def _async_read_file_content(file: FileContent) -> HttpxFileContent:
+async def async_read_file_content(file: FileContent) -> HttpxFileContent:
     if isinstance(file, os.PathLike):
         return await anyio.Path(file).read_bytes()
 

{payi-0.1.0a106 → payi-0.1.0a108}/src/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.106"  # x-release-please-version
+__version__ = "0.1.0-alpha.108"  # x-release-please-version

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/lib/helpers.py

@@ -11,6 +11,7 @@ class PayiHeaderNames:
     use_case_version:str = "xProxy-UseCase-Version"
     use_case_step:str = "xProxy-UseCase-Step"
     user_id:str = "xProxy-User-ID"
+    account_name:str = "xProxy-Account-Name"
     price_as_category:str = "xProxy-PriceAs-Category"
     price_as_resource:str = "xProxy-PriceAs-Resource"
     provider_base_uri = "xProxy-Provider-BaseUri"
@@ -24,7 +25,7 @@ class PayiCategories:
     aws_bedrock:str = "system.aws.bedrock"
     google_vertex:str = "system.google.vertex"
 
-def create_limit_header_from_ids(limit_ids: List[str]) -> Dict[str, str]:
+def create_limit_header_from_ids(*, limit_ids: List[str]) -> Dict[str, str]:
     if not isinstance(limit_ids, list):  # type: ignore
         raise TypeError("limit_ids must be a list")
 
@@ -32,7 +33,7 @@ def create_limit_header_from_ids(limit_ids: List[str]) -> Dict[str, str]:
 
     return { PayiHeaderNames.limit_ids: ",".join(valid_ids) } if valid_ids else {}
 
-def create_request_header_from_tags(request_tags: List[str]) -> Dict[str, str]:
+def create_request_header_from_tags(*, request_tags: List[str]) -> Dict[str, str]:
     if not isinstance(request_tags, list):  # type: ignore
         raise TypeError("request_tags must be a list")
 
@@ -41,9 +42,11 @@ def create_request_header_from_tags(request_tags: List[str]) -> Dict[str, str]:
     return { PayiHeaderNames.request_tags: ",".join(valid_tags) } if valid_tags else {}
 
 def create_headers(
+    *,
     limit_ids: Union[List[str], None] = None,
     request_tags: Union[List[str], None] = None,
     user_id: Union[str, None] = None,
+    account_name: Union[str, None] = None,
     use_case_id: Union[str, None] = None,
     use_case_name: Union[str, None] = None,
     use_case_version: Union[int, None] = None,
@@ -55,11 +58,13 @@ def create_headers(
     headers: Dict[str, str] = {}
 
     if limit_ids:
-        headers.update(create_limit_header_from_ids(limit_ids))
+        headers.update(create_limit_header_from_ids(limit_ids=limit_ids))
     if request_tags:
-        headers.update(create_request_header_from_tags(request_tags))
+        headers.update(create_request_header_from_tags(request_tags=request_tags))
     if user_id:
         headers.update({ PayiHeaderNames.user_id: user_id})
+    if account_name:
+        headers.update({ PayiHeaderNames.account_name: account_name})
     if use_case_id:
         headers.update({ PayiHeaderNames.use_case_id: use_case_id})
     if use_case_name:

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/lib/instrument.py

@@ -157,6 +157,7 @@ class PayiInstrumentConfig(TypedDict, total=False):
     use_case_version: Optional[int]
     use_case_properties: Optional["dict[str, str]"]
     user_id: Optional[str]
+    account_name: Optional[str]
     request_tags: Optional["list[str]"]
     request_properties: Optional["dict[str, str]"]
 
@@ -168,6 +169,7 @@ class PayiContext(TypedDict, total=False):
     use_case_properties: Optional["dict[str, str]"]
     limit_ids: Optional['list[str]']
     user_id: Optional[str]
+    account_name: Optional[str]
     request_tags: Optional["list[str]"]
     request_properties: Optional["dict[str, str]"]
     price_as_category: Optional[str]
@@ -184,6 +186,7 @@ class _Context(TypedDict, total=False):
     use_case_properties: Optional["dict[str, str]"]
     limit_ids: Optional['list[str]']
     user_id: Optional[str]
+    account_name: Optional[str]
     request_tags: Optional["list[str]"]
     request_properties: Optional["dict[str, str]"]
     price_as_category: Optional[str]
@@ -655,6 +658,7 @@ class _PayiInstrumentor:
         use_case_version: Optional[int]= None,
         use_case_step: Optional[str]= None,
         user_id: Optional[str]= None,
+        account_name: Optional[str]= None,
         request_tags: Optional["list[str]"] = None,
         request_properties: Optional["dict[str, str]"] = None,
         use_case_properties: Optional["dict[str, str]"] = None,
@@ -747,6 +751,16 @@ class _PayiInstrumentor:
         else:
             context["user_id"] = user_id
 
+        parent_account_name = parent_context.get("account_name", None)
+        if account_name is None:
+            # use the parent account_name if it exists
+            context["account_name"] = parent_account_name
+        elif len(account_name) == 0:
+            # caller passing an empty string explicitly blocks inheriting from the parent state
+            context["account_name"] = None
+        else:
+            context["account_name"] = account_name
+
         parent_request_tags = parent_context.get("request_tags", None)
         if request_tags is not None:
             if len(request_tags) == 0:
@@ -795,6 +809,7 @@ class _PayiInstrumentor:
         use_case_id: Optional[str],
         use_case_version: Optional[int],        
         user_id: Optional[str],
+        account_name: Optional[str],
         request_tags: Optional["list[str]"] = None,
         request_properties: Optional["dict[str, str]"] = None,
         use_case_properties: Optional["dict[str, str]"] = None,
@@ -809,6 +824,7 @@ class _PayiInstrumentor:
                 use_case_id=use_case_id,
                 use_case_version=use_case_version,
                 user_id=user_id,
+                account_name=account_name,
                 request_tags=request_tags,
                 request_properties=request_properties,
                 use_case_properties=use_case_properties
@@ -824,6 +840,7 @@ class _PayiInstrumentor:
         use_case_id: Optional[str],
         use_case_version: Optional[int],        
         user_id: Optional[str],
+        account_name: Optional[str],
         request_tags: Optional["list[str]"] = None,
         request_properties: Optional["dict[str, str]"] = None,
         use_case_properties: Optional["dict[str, str]"] = None,
@@ -838,6 +855,7 @@ class _PayiInstrumentor:
                 use_case_id=use_case_id,
                 use_case_version=use_case_version,
                 user_id=user_id,
+                account_name=account_name,
                 request_tags=request_tags,
                 request_properties=request_properties,
                 use_case_properties=use_case_properties)
@@ -879,6 +897,7 @@ class _PayiInstrumentor:
         use_case_step = ingest_extra_headers.pop(PayiHeaderNames.use_case_step, None)
 
         user_id = ingest_extra_headers.pop(PayiHeaderNames.user_id, None)
+        account_name = ingest_extra_headers.pop(PayiHeaderNames.account_name, None)
 
         if limit_ids:
             request._ingest["limit_ids"] = limit_ids.split(",")
@@ -894,6 +913,8 @@ class _PayiInstrumentor:
             request._ingest["use_case_step"] = use_case_step
         if user_id:
             request._ingest["user_id"] = user_id
+        if account_name:
+            request._ingest["account_name"] = account_name
 
         request_properties = context.get("request_properties", None)
         if request_properties:
@@ -1207,6 +1228,7 @@ class _PayiInstrumentor:
         context_use_case_step: Optional[str] = context.get("use_case_step")
 
         context_user_id: Optional[str] = context.get("user_id")
+        context_account_name: Optional[str] = context.get("account_name")
         context_request_tags: Optional[list[str]] = context.get("request_tags")
 
         context_price_as_category: Optional[str] = context.get("price_as_category")
@@ -1239,6 +1261,17 @@ class _PayiInstrumentor:
         elif context_user_id:
             extra_headers[PayiHeaderNames.user_id] = context_user_id
 
+        if PayiHeaderNames.account_name in extra_headers:
+            headers_account_name = extra_headers.get(PayiHeaderNames.account_name, None)
+            if headers_account_name is None or len(headers_account_name) == 0:
+                # headers_account_name is empty, remove it from extra_headers
+                extra_headers.pop(PayiHeaderNames.account_name, None)
+            else:
+                # leave the value in extra_headers
+                ...
+        elif context_account_name:
+            extra_headers[PayiHeaderNames.account_name] = context_account_name
+
         if PayiHeaderNames.use_case_name in extra_headers:
             headers_use_case_name = extra_headers.get(PayiHeaderNames.use_case_name, None)
             if headers_use_case_name is None or len(headers_use_case_name) == 0:
@@ -1711,6 +1744,7 @@ def track(
     use_case_id: Optional[str] = None,
     use_case_version: Optional[int] = None,
     user_id: Optional[str] = None,
+    account_name: Optional[str] = None,
     request_tags: Optional["list[str]"] = None,
     request_properties: Optional["dict[str, str]"] = None,
     use_case_properties: Optional["dict[str, str]"] = None,
@@ -1735,6 +1769,7 @@ def track(
                     use_case_id,
                     use_case_version,
                     user_id,
+                    account_name,
                     request_tags,
                     request_properties,
                     use_case_properties,
@@ -1748,7 +1783,7 @@ def track(
                     _g_logger.debug(f"track: no instrumentor!")
                     return func(*args, **kwargs)
 
-                _instrumentor._logger.debug(f"track: call sync function (proxy={proxy}, limit_ids={limit_ids}, use_case_name={use_case_name}, use_case_id={use_case_id}, use_case_version={use_case_version}, user_id={user_id})")
+                _instrumentor._logger.debug(f"track: call sync function (proxy={proxy}, limit_ids={limit_ids}, use_case_name={use_case_name}, use_case_id={use_case_id}, use_case_version={use_case_version}, user_id={user_id}, account_name={account_name})")
 
                 return _instrumentor._call_func(
                     func,
@@ -1758,6 +1793,7 @@ def track(
                     use_case_id,
                     use_case_version,
                     user_id,
+                    account_name,
                     request_tags,
                     request_properties,
                     use_case_properties,
@@ -1775,6 +1811,7 @@ def track_context(
     use_case_version: Optional[int] = None,
     use_case_step: Optional[str] = None,
     user_id: Optional[str] = None,
+    account_name: Optional[str] = None,
     request_tags: Optional["list[str]"] = None,
     request_properties: Optional["dict[str, str]"] = None,
     use_case_properties: Optional["dict[str, str]"] = None,
@@ -1796,6 +1833,7 @@ def track_context(
     context["use_case_step"] = use_case_step
 
     context["user_id"] = user_id
+    context["account_name"] = account_name
     context["request_tags"] = request_tags
 
     context["price_as_category"] = price_as_category

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/resources/ingest.py

@@ -86,7 +86,6 @@ class IngestResource(SyncAPIResource):
         self,
         *,
         category: str,
-        resource: str,
         units: Dict[str, IngestUnits],
         end_to_end_latency_ms: Optional[int] | NotGiven = NOT_GIVEN,
         event_timestamp: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
@@ -101,6 +100,7 @@ class IngestResource(SyncAPIResource):
         provider_response_id: Optional[str] | NotGiven = NOT_GIVEN,
         provider_response_json: Union[str, List[str], None] | NotGiven = NOT_GIVEN,
         provider_uri: Optional[str] | NotGiven = NOT_GIVEN,
+        resource: Optional[str] | NotGiven = NOT_GIVEN,
         time_to_first_completion_token_ms: Optional[int] | NotGiven = NOT_GIVEN,
         time_to_first_token_ms: Optional[int] | NotGiven = NOT_GIVEN,
         use_case_properties: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
@@ -233,7 +233,6 @@ class IngestResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "category": category,
-                    "resource": resource,
                     "units": units,
                     "end_to_end_latency_ms": end_to_end_latency_ms,
                     "event_timestamp": event_timestamp,
@@ -247,6 +246,7 @@ class IngestResource(SyncAPIResource):
                     "provider_response_id": provider_response_id,
                     "provider_response_json": provider_response_json,
                     "provider_uri": provider_uri,
+                    "resource": resource,
                     "time_to_first_completion_token_ms": time_to_first_completion_token_ms,
                     "time_to_first_token_ms": time_to_first_token_ms,
                     "use_case_properties": use_case_properties,
@@ -316,7 +316,6 @@ class AsyncIngestResource(AsyncAPIResource):
         self,
         *,
         category: str,
-        resource: str,
         units: Dict[str, IngestUnits],
         end_to_end_latency_ms: Optional[int] | NotGiven = NOT_GIVEN,
         event_timestamp: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
@@ -331,6 +330,7 @@ class AsyncIngestResource(AsyncAPIResource):
         provider_response_id: Optional[str] | NotGiven = NOT_GIVEN,
         provider_response_json: Union[str, List[str], None] | NotGiven = NOT_GIVEN,
         provider_uri: Optional[str] | NotGiven = NOT_GIVEN,
+        resource: Optional[str] | NotGiven = NOT_GIVEN,
         time_to_first_completion_token_ms: Optional[int] | NotGiven = NOT_GIVEN,
         time_to_first_token_ms: Optional[int] | NotGiven = NOT_GIVEN,
         use_case_properties: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
@@ -461,7 +461,6 @@ class AsyncIngestResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "category": category,
-                    "resource": resource,
                     "units": units,
                     "end_to_end_latency_ms": end_to_end_latency_ms,
                     "event_timestamp": event_timestamp,
@@ -475,6 +474,7 @@ class AsyncIngestResource(AsyncAPIResource):
                     "provider_response_id": provider_response_id,
                     "provider_response_json": provider_response_json,
                     "provider_uri": provider_uri,
+                    "resource": resource,
                     "time_to_first_completion_token_ms": time_to_first_completion_token_ms,
                     "time_to_first_token_ms": time_to_first_token_ms,
                     "use_case_properties": use_case_properties,

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/resources/limits/limits.py

@@ -66,8 +66,6 @@ class LimitsResource(SyncAPIResource):
         *,
         limit_name: str,
         max: float,
-        billing_model_id: Optional[str] | NotGiven = NOT_GIVEN,
-        limit_basis: Literal["base", "billed"] | NotGiven = NOT_GIVEN,
         limit_id: Optional[str] | NotGiven = NOT_GIVEN,
         limit_tags: Optional[List[str]] | NotGiven = NOT_GIVEN,
         limit_type: Literal["block", "allow"] | NotGiven = NOT_GIVEN,
@@ -97,8 +95,6 @@ class LimitsResource(SyncAPIResource):
                 {
                     "limit_name": limit_name,
                     "max": max,
-                    "billing_model_id": billing_model_id,
-                    "limit_basis": limit_basis,
                     "limit_id": limit_id,
                     "limit_tags": limit_tags,
                     "limit_type": limit_type,
@@ -337,8 +333,6 @@ class AsyncLimitsResource(AsyncAPIResource):
         *,
         limit_name: str,
         max: float,
-        billing_model_id: Optional[str] | NotGiven = NOT_GIVEN,
-        limit_basis: Literal["base", "billed"] | NotGiven = NOT_GIVEN,
         limit_id: Optional[str] | NotGiven = NOT_GIVEN,
         limit_tags: Optional[List[str]] | NotGiven = NOT_GIVEN,
         limit_type: Literal["block", "allow"] | NotGiven = NOT_GIVEN,
@@ -368,8 +362,6 @@ class AsyncLimitsResource(AsyncAPIResource):
                 {
                     "limit_name": limit_name,
                     "max": max,
-                    "billing_model_id": billing_model_id,
-                    "limit_basis": limit_basis,
                     "limit_id": limit_id,
                     "limit_tags": limit_tags,
                     "limit_type": limit_type,

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/resources/use_cases/definitions/kpis.py

@@ -54,9 +54,9 @@ class KpisResource(SyncAPIResource):
         use_case_name: str,
         *,
         description: str,
+        goal: float,
+        kpi_type: Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"],
         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,
@@ -65,7 +65,7 @@ class KpisResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> KpiCreateResponse:
         """
-        Create a new Use Case KPI definition
+        Create a new KPI definition for a Use Case
 
         Args:
           extra_headers: Send extra headers
@@ -83,9 +83,9 @@ class KpisResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "description": description,
-                    "name": name,
                     "goal": goal,
                     "kpi_type": kpi_type,
+                    "name": name,
                 },
                 kpi_create_params.KpiCreateParams,
             ),
@@ -146,7 +146,7 @@ class KpisResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> KpiUpdateResponse:
         """
-        Update a Use Case KPI definition
+        Update a KPI definition for a Use Case
 
         Args:
           extra_headers: Send extra headers
@@ -239,7 +239,7 @@ class KpisResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> KpiDeleteResponse:
         """
-        Delete a Use Case KPI definition
+        Delete a KPI definition for a Use Case
 
         Args:
           extra_headers: Send extra headers
@@ -288,9 +288,9 @@ class AsyncKpisResource(AsyncAPIResource):
         use_case_name: str,
         *,
         description: str,
+        goal: float,
+        kpi_type: Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"],
         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,
@@ -299,7 +299,7 @@ class AsyncKpisResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> KpiCreateResponse:
         """
-        Create a new Use Case KPI definition
+        Create a new KPI definition for a Use Case
 
         Args:
           extra_headers: Send extra headers
@@ -317,9 +317,9 @@ class AsyncKpisResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "description": description,
-                    "name": name,
                     "goal": goal,
                     "kpi_type": kpi_type,
+                    "name": name,
                 },
                 kpi_create_params.KpiCreateParams,
             ),
@@ -380,7 +380,7 @@ class AsyncKpisResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> KpiUpdateResponse:
         """
-        Update a Use Case KPI definition
+        Update a KPI definition for a Use Case
 
         Args:
           extra_headers: Send extra headers
@@ -473,7 +473,7 @@ class AsyncKpisResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> KpiDeleteResponse:
         """
-        Delete a Use Case KPI definition
+        Delete a KPI definition for a Use Case
 
         Args:
           extra_headers: Send extra headers

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/resources/use_cases/kpis.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Union
+
 import httpx
 
 from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
@@ -47,7 +49,7 @@ class KpisResource(SyncAPIResource):
         kpi_name: str,
         *,
         use_case_id: str,
-        score: float | NotGiven = NOT_GIVEN,
+        score: Union[bool, float, None] | 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,
@@ -157,7 +159,7 @@ class AsyncKpisResource(AsyncAPIResource):
         kpi_name: str,
         *,
         use_case_id: str,
-        score: float | NotGiven = NOT_GIVEN,
+        score: Union[bool, float, None] | 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,

{payi-0.1.0a106 → payi-0.1.0a108}/src/payi/resources/use_cases/properties.py

@@ -18,7 +18,7 @@ from ..._response import (
 )
 from ..._base_client import make_request_options
 from ...types.use_cases import property_update_params
-from ...types.use_cases.property_create_response import PropertyCreateResponse
+from ...types.use_case_instance_response import UseCaseInstanceResponse
 
 __all__ = ["PropertiesResource", "AsyncPropertiesResource"]
 
@@ -54,7 +54,7 @@ class PropertiesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> PropertyCreateResponse:
+    ) -> UseCaseInstanceResponse:
         """
         Update a Use Case instance properties
 
@@ -75,7 +75,7 @@ class PropertiesResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=PropertyCreateResponse,
+            cast_to=UseCaseInstanceResponse,
         )
 
 
@@ -110,7 +110,7 @@ class AsyncPropertiesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> PropertyCreateResponse:
+    ) -> UseCaseInstanceResponse:
         """
         Update a Use Case instance properties
 
@@ -131,7 +131,7 @@ class AsyncPropertiesResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=PropertyCreateResponse,
+            cast_to=UseCaseInstanceResponse,
         )