payi 0.1.0a58__tar.gz → 0.1.0a60__tar.gz

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

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

{payi-0.1.0a58 → payi-0.1.0a60}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.0-alpha.60 (2025-04-07)
+
+Full Changelog: [v0.1.0-alpha.59...v0.1.0-alpha.60](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.59...v0.1.0-alpha.60)
+
+### Features
+
+* **api:** KPIs ([#274](https://github.com/Pay-i/pay-i-python/issues/274)) ([1e6d054](https://github.com/Pay-i/pay-i-python/commit/1e6d0540471a07ac43fe9d32c5b30c1b153e5b70))
+
+## 0.1.0-alpha.59 (2025-04-04)
+
+Full Changelog: [v0.1.0-alpha.58...v0.1.0-alpha.59](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.58...v0.1.0-alpha.59)
+
+### Chores
+
+* **internal:** remove trailing character ([#271](https://github.com/Pay-i/pay-i-python/issues/271)) ([ea4292f](https://github.com/Pay-i/pay-i-python/commit/ea4292f2513b35ac475d494351fe77e7db2c9f57))
+
 ## 0.1.0-alpha.58 (2025-03-27)
 
 Full Changelog: [v0.1.0-alpha.57...v0.1.0-alpha.58](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.57...v0.1.0-alpha.58)

{payi-0.1.0a58 → payi-0.1.0a60}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a58
+Version: 0.1.0a60
 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
@@ -65,11 +65,11 @@ client = Payi(
     api_key=os.environ.get("PAYI_API_KEY"),  # This is the default and can be omitted
 )
 
-limit_response = client.limits.create(
-    limit_name="x",
-    max=1,
+use_case_definition = client.use_cases.definitions.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
-print(limit_response.request_id)
+print(use_case_definition.request_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -92,11 +92,11 @@ client = AsyncPayi(
 
 
 async def main() -> None:
-    limit_response = await client.limits.create(
-        limit_name="x",
-        max=1,
+    use_case_definition = await client.use_cases.definitions.create(
+        description="Sample Use Case Definition Description",
+        name="SampleUseCaseDefinition",
     )
-    print(limit_response.request_id)
+    print(use_case_definition.request_id)
 
 
 asyncio.run(main())
@@ -113,6 +113,69 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Payi API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from payi import Payi
+
+client = Payi()
+
+all_definitions = []
+# Automatically fetches more pages as needed.
+for definition in client.use_cases.definitions.list():
+    # Do something with definition here
+    all_definitions.append(definition)
+print(all_definitions)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from payi import AsyncPayi
+
+client = AsyncPayi()
+
+
+async def main() -> None:
+    all_definitions = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for definition in client.use_cases.definitions.list():
+        all_definitions.append(definition)
+    print(all_definitions)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.use_cases.definitions.list()
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.items)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.use_cases.definitions.list()
+
+print(f"next page cursor: {first_page.cursor}")  # => "next page cursor: ..."
+for definition in first_page.items:
+    print(definition.request_id)
+
+# Remove `await` for non-async usage.
+```
+
 ## Nested params
 
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
@@ -122,7 +185,7 @@ from payi import Payi
 
 client = Payi()
 
-experience_type = client.experiences.types.create(
+use_case_definition = client.use_cases.definitions.create(
     description="x",
     name="x",
     limit_config={
@@ -132,7 +195,7 @@ experience_type = client.experiences.types.create(
         "threshold": 0,
     },
 )
-print(experience_type.limit_config)
+print(use_case_definition.limit_config)
 ```
 
 ## Handling errors
@@ -151,9 +214,9 @@ from payi import Payi
 client = Payi()
 
 try:
-    client.limits.create(
-        limit_name="x",
-        max=1,
+    client.use_cases.definitions.create(
+        description="Sample Use Case Definition Description",
+        name="SampleUseCaseDefinition",
     )
 except payi.APIConnectionError as e:
     print("The server could not be reached")
@@ -197,9 +260,9 @@ client = Payi(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).limits.create(
-    limit_name="x",
-    max=1,
+client.with_options(max_retries=5).use_cases.definitions.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
 ```
 
@@ -223,9 +286,9 @@ client = Payi(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).limits.create(
-    limit_name="x",
-    max=1,
+client.with_options(timeout=5.0).use_cases.definitions.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
 ```
 
@@ -267,14 +330,14 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from payi import Payi
 
 client = Payi()
-response = client.limits.with_raw_response.create(
-    limit_name="x",
-    max=1,
+response = client.use_cases.definitions.with_raw_response.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
 print(response.headers.get('X-My-Header'))
 
-limit = response.parse()  # get the object that `limits.create()` would have returned
-print(limit.request_id)
+definition = response.parse()  # get the object that `use_cases.definitions.create()` would have returned
+print(definition.request_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Pay-i/pay-i-python/tree/main/src/payi/_response.py) object.
@@ -288,9 +351,9 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.limits.with_streaming_response.create(
-    limit_name="x",
-    max=1,
+with client.use_cases.definitions.with_streaming_response.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{payi-0.1.0a58 → payi-0.1.0a60}/README.md

@@ -31,11 +31,11 @@ client = Payi(
     api_key=os.environ.get("PAYI_API_KEY"),  # This is the default and can be omitted
 )
 
-limit_response = client.limits.create(
-    limit_name="x",
-    max=1,
+use_case_definition = client.use_cases.definitions.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
-print(limit_response.request_id)
+print(use_case_definition.request_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -58,11 +58,11 @@ client = AsyncPayi(
 
 
 async def main() -> None:
-    limit_response = await client.limits.create(
-        limit_name="x",
-        max=1,
+    use_case_definition = await client.use_cases.definitions.create(
+        description="Sample Use Case Definition Description",
+        name="SampleUseCaseDefinition",
     )
-    print(limit_response.request_id)
+    print(use_case_definition.request_id)
 
 
 asyncio.run(main())
@@ -79,6 +79,69 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Payi API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from payi import Payi
+
+client = Payi()
+
+all_definitions = []
+# Automatically fetches more pages as needed.
+for definition in client.use_cases.definitions.list():
+    # Do something with definition here
+    all_definitions.append(definition)
+print(all_definitions)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from payi import AsyncPayi
+
+client = AsyncPayi()
+
+
+async def main() -> None:
+    all_definitions = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for definition in client.use_cases.definitions.list():
+        all_definitions.append(definition)
+    print(all_definitions)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.use_cases.definitions.list()
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.items)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.use_cases.definitions.list()
+
+print(f"next page cursor: {first_page.cursor}")  # => "next page cursor: ..."
+for definition in first_page.items:
+    print(definition.request_id)
+
+# Remove `await` for non-async usage.
+```
+
 ## Nested params
 
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
@@ -88,7 +151,7 @@ from payi import Payi
 
 client = Payi()
 
-experience_type = client.experiences.types.create(
+use_case_definition = client.use_cases.definitions.create(
     description="x",
     name="x",
     limit_config={
@@ -98,7 +161,7 @@ experience_type = client.experiences.types.create(
         "threshold": 0,
     },
 )
-print(experience_type.limit_config)
+print(use_case_definition.limit_config)
 ```
 
 ## Handling errors
@@ -117,9 +180,9 @@ from payi import Payi
 client = Payi()
 
 try:
-    client.limits.create(
-        limit_name="x",
-        max=1,
+    client.use_cases.definitions.create(
+        description="Sample Use Case Definition Description",
+        name="SampleUseCaseDefinition",
     )
 except payi.APIConnectionError as e:
     print("The server could not be reached")
@@ -163,9 +226,9 @@ client = Payi(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).limits.create(
-    limit_name="x",
-    max=1,
+client.with_options(max_retries=5).use_cases.definitions.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
 ```
 
@@ -189,9 +252,9 @@ client = Payi(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).limits.create(
-    limit_name="x",
-    max=1,
+client.with_options(timeout=5.0).use_cases.definitions.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
 ```
 
@@ -233,14 +296,14 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from payi import Payi
 
 client = Payi()
-response = client.limits.with_raw_response.create(
-    limit_name="x",
-    max=1,
+response = client.use_cases.definitions.with_raw_response.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 )
 print(response.headers.get('X-My-Header'))
 
-limit = response.parse()  # get the object that `limits.create()` would have returned
-print(limit.request_id)
+definition = response.parse()  # get the object that `use_cases.definitions.create()` would have returned
+print(definition.request_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Pay-i/pay-i-python/tree/main/src/payi/_response.py) object.
@@ -254,9 +317,9 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.limits.with_streaming_response.create(
-    limit_name="x",
-    max=1,
+with client.use_cases.definitions.with_streaming_response.create(
+    description="Sample Use Case Definition Description",
+    name="SampleUseCaseDefinition",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{payi-0.1.0a58 → payi-0.1.0a60}/api.md

@@ -19,9 +19,9 @@ from payi.types import (
     DefaultResponse,
     LimitHistoryResponse,
     LimitResponse,
-    PagedLimitList,
     RequestsData,
     TotalCostData,
+    LimitListResponse,
 )
 ```
 
@@ -30,7 +30,7 @@ Methods:
 - <code title="post /api/v1/limits">client.limits.<a href="./src/payi/resources/limits/limits.py">create</a>(\*\*<a href="src/payi/types/limit_create_params.py">params</a>) -> <a href="./src/payi/types/limit_response.py">LimitResponse</a></code>
 - <code title="get /api/v1/limits/{limit_id}">client.limits.<a href="./src/payi/resources/limits/limits.py">retrieve</a>(limit_id) -> <a href="./src/payi/types/limit_response.py">LimitResponse</a></code>
 - <code title="put /api/v1/limits/{limit_id}">client.limits.<a href="./src/payi/resources/limits/limits.py">update</a>(limit_id, \*\*<a href="src/payi/types/limit_update_params.py">params</a>) -> <a href="./src/payi/types/limit_response.py">LimitResponse</a></code>
-- <code title="get /api/v1/limits">client.limits.<a href="./src/payi/resources/limits/limits.py">list</a>(\*\*<a href="src/payi/types/limit_list_params.py">params</a>) -> <a href="./src/payi/types/paged_limit_list.py">PagedLimitList</a></code>
+- <code title="get /api/v1/limits">client.limits.<a href="./src/payi/resources/limits/limits.py">list</a>(\*\*<a href="src/payi/types/limit_list_params.py">params</a>) -> <a href="./src/payi/types/limit_list_response.py">SyncCursorPage[LimitListResponse]</a></code>
 - <code title="delete /api/v1/limits/{limit_id}">client.limits.<a href="./src/payi/resources/limits/limits.py">delete</a>(limit_id) -> <a href="./src/payi/types/default_response.py">DefaultResponse</a></code>
 - <code title="post /api/v1/limits/{limit_id}/reset">client.limits.<a href="./src/payi/resources/limits/limits.py">reset</a>(limit_id, \*\*<a href="src/payi/types/limit_reset_params.py">params</a>) -> <a href="./src/payi/types/limit_history_response.py">LimitHistoryResponse</a></code>
 
@@ -84,33 +84,25 @@ Types:
 from payi.types import (
     CategoryResourceResponse,
     CategoryResponse,
-    CategoryListResponse,
     CategoryDeleteResponse,
     CategoryDeleteResourceResponse,
-    CategoryListResourcesResponse,
 )
 ```
 
 Methods:
 
-- <code title="get /api/v1/categories">client.categories.<a href="./src/payi/resources/categories/categories.py">list</a>() -> <a href="./src/payi/types/category_list_response.py">CategoryListResponse</a></code>
+- <code title="get /api/v1/categories">client.categories.<a href="./src/payi/resources/categories/categories.py">list</a>(\*\*<a href="src/payi/types/category_list_params.py">params</a>) -> <a href="./src/payi/types/category_response.py">SyncCursorPage[CategoryResponse]</a></code>
 - <code title="delete /api/v1/categories/{category}">client.categories.<a href="./src/payi/resources/categories/categories.py">delete</a>(category) -> <a href="./src/payi/types/category_delete_response.py">CategoryDeleteResponse</a></code>
 - <code title="delete /api/v1/categories/{category}/resources/{resource}">client.categories.<a href="./src/payi/resources/categories/categories.py">delete_resource</a>(resource, \*, category) -> <a href="./src/payi/types/category_delete_resource_response.py">CategoryDeleteResourceResponse</a></code>
-- <code title="get /api/v1/categories/{category}/resources">client.categories.<a href="./src/payi/resources/categories/categories.py">list_resources</a>(category) -> <a href="./src/payi/types/category_list_resources_response.py">CategoryListResourcesResponse</a></code>
+- <code title="get /api/v1/categories/{category}/resources">client.categories.<a href="./src/payi/resources/categories/categories.py">list_resources</a>(category, \*\*<a href="src/payi/types/category_list_resources_params.py">params</a>) -> <a href="./src/payi/types/category_resource_response.py">SyncCursorPage[CategoryResourceResponse]</a></code>
 
 ## Resources
 
-Types:
-
-```python
-from payi.types.categories import ResourceListResponse
-```
-
 Methods:
 
 - <code title="post /api/v1/categories/{category}/resources/{resource}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">create</a>(resource, \*, category, \*\*<a href="src/payi/types/categories/resource_create_params.py">params</a>) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
 - <code title="get /api/v1/categories/{category}/resources/{resource}/{resource_id}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">retrieve</a>(resource_id, \*, category, resource) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
-- <code title="get /api/v1/categories/{category}/resources/{resource}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">list</a>(resource, \*, category) -> <a href="./src/payi/types/categories/resource_list_response.py">ResourceListResponse</a></code>
+- <code title="get /api/v1/categories/{category}/resources/{resource}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">list</a>(resource, \*, category, \*\*<a href="src/payi/types/categories/resource_list_params.py">params</a>) -> <a href="./src/payi/types/category_resource_response.py">SyncCursorPage[CategoryResourceResponse]</a></code>
 - <code title="delete /api/v1/categories/{category}/resources/{resource}/{resource_id}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">delete</a>(resource_id, \*, category, resource) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
 
 # Experiences
@@ -132,15 +124,15 @@ Methods:
 Types:
 
 ```python
-from payi.types.experiences import ExperienceType, TypeListResponse
+from payi.types.experiences import ExperienceType
 ```
 
 Methods:
 
 - <code title="post /api/v1/experiences/types">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">create</a>(\*\*<a href="src/payi/types/experiences/type_create_params.py">params</a>) -> <a href="./src/payi/types/experiences/experience_type.py">ExperienceType</a></code>
 - <code title="get /api/v1/experiences/types/{experience_name}">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">retrieve</a>(experience_name) -> <a href="./src/payi/types/experiences/experience_type.py">ExperienceType</a></code>
-- <code title="patch /api/v1/experiences/types/{experience_name}">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">update</a>(experience_name, \*\*<a href="src/payi/types/experiences/type_update_params.py">params</a>) -> <a href="./src/payi/types/experiences/experience_type.py">ExperienceType</a></code>
-- <code title="get /api/v1/experiences/types">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">list</a>(\*\*<a href="src/payi/types/experiences/type_list_params.py">params</a>) -> <a href="./src/payi/types/experiences/type_list_response.py">TypeListResponse</a></code>
+- <code title="put /api/v1/experiences/types/{experience_name}">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">update</a>(experience_name, \*\*<a href="src/payi/types/experiences/type_update_params.py">params</a>) -> <a href="./src/payi/types/experiences/experience_type.py">ExperienceType</a></code>
+- <code title="get /api/v1/experiences/types">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">list</a>(\*\*<a href="src/payi/types/experiences/type_list_params.py">params</a>) -> <a href="./src/payi/types/experiences/experience_type.py">SyncCursorPage[ExperienceType]</a></code>
 - <code title="delete /api/v1/experiences/types/{experience_name}">client.experiences.types.<a href="./src/payi/resources/experiences/types/types.py">delete</a>(experience_name) -> <a href="./src/payi/types/experiences/experience_type.py">ExperienceType</a></code>
 
 ### LimitConfig
@@ -170,22 +162,59 @@ Methods:
 - <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
+
+Types:
+
+```python
+from payi.types.use_cases import KpiListResponse
+```
+
+Methods:
+
+- <code title="post /api/v1/use_cases/instances/{use_case_id}/kpis/{kpi_name}">client.use_cases.kpis.<a href="./src/payi/resources/use_cases/kpis.py">create</a>(kpi_name, \*, use_case_id, \*\*<a href="src/payi/types/use_cases/kpi_create_params.py">params</a>) -> None</code>
+- <code title="put /api/v1/use_cases/instances/{use_case_id}/kpis/{kpi_name}">client.use_cases.kpis.<a href="./src/payi/resources/use_cases/kpis.py">update</a>(kpi_name, \*, use_case_id, \*\*<a href="src/payi/types/use_cases/kpi_update_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/use_cases/instances/{use_case_id}/kpis">client.use_cases.kpis.<a href="./src/payi/resources/use_cases/kpis.py">list</a>(use_case_id, \*\*<a href="src/payi/types/use_cases/kpi_list_params.py">params</a>) -> <a href="./src/payi/types/use_cases/kpi_list_response.py">SyncCursorPage[KpiListResponse]</a></code>
+- <code title="delete /api/v1/use_cases/instances/{use_case_id}/kpis/{kpi_name}">client.use_cases.kpis.<a href="./src/payi/resources/use_cases/kpis.py">delete</a>(kpi_name, \*, use_case_id) -> None</code>
+
 ## Definitions
 
 Types:
 
 ```python
-from payi.types.use_cases import UseCaseDefinition, DefinitionListResponse
+from payi.types.use_cases import UseCaseDefinition
 ```
 
 Methods:
 
 - <code title="post /api/v1/use_cases/definitions">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">create</a>(\*\*<a href="src/payi/types/use_cases/definition_create_params.py">params</a>) -> <a href="./src/payi/types/use_cases/use_case_definition.py">UseCaseDefinition</a></code>
 - <code title="get /api/v1/use_cases/definitions/{use_case_name}">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">retrieve</a>(use_case_name) -> <a href="./src/payi/types/use_cases/use_case_definition.py">UseCaseDefinition</a></code>
-- <code title="patch /api/v1/use_cases/definitions/{use_case_name}">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">update</a>(use_case_name, \*\*<a href="src/payi/types/use_cases/definition_update_params.py">params</a>) -> <a href="./src/payi/types/use_cases/use_case_definition.py">UseCaseDefinition</a></code>
-- <code title="get /api/v1/use_cases/definitions">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">list</a>(\*\*<a href="src/payi/types/use_cases/definition_list_params.py">params</a>) -> <a href="./src/payi/types/use_cases/definition_list_response.py">DefinitionListResponse</a></code>
+- <code title="put /api/v1/use_cases/definitions/{use_case_name}">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">update</a>(use_case_name, \*\*<a href="src/payi/types/use_cases/definition_update_params.py">params</a>) -> <a href="./src/payi/types/use_cases/use_case_definition.py">UseCaseDefinition</a></code>
+- <code title="get /api/v1/use_cases/definitions">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">list</a>(\*\*<a href="src/payi/types/use_cases/definition_list_params.py">params</a>) -> <a href="./src/payi/types/use_cases/use_case_definition.py">SyncCursorPage[UseCaseDefinition]</a></code>
 - <code title="delete /api/v1/use_cases/definitions/{use_case_name}">client.use_cases.definitions.<a href="./src/payi/resources/use_cases/definitions/definitions.py">delete</a>(use_case_name) -> <a href="./src/payi/types/use_cases/use_case_definition.py">UseCaseDefinition</a></code>
 
+### Kpis
+
+Types:
+
+```python
+from payi.types.use_cases.definitions import (
+    KpiCreateResponse,
+    KpiRetrieveResponse,
+    KpiUpdateResponse,
+    KpiListResponse,
+    KpiDeleteResponse,
+)
+```
+
+Methods:
+
+- <code title="post /api/v1/use_cases/definitions/{use_case_name}/kpis">client.use_cases.definitions.kpis.<a href="./src/payi/resources/use_cases/definitions/kpis.py">create</a>(use_case_name, \*\*<a href="src/payi/types/use_cases/definitions/kpi_create_params.py">params</a>) -> <a href="./src/payi/types/use_cases/definitions/kpi_create_response.py">KpiCreateResponse</a></code>
+- <code title="get /api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}">client.use_cases.definitions.kpis.<a href="./src/payi/resources/use_cases/definitions/kpis.py">retrieve</a>(kpi_name, \*, use_case_name) -> <a href="./src/payi/types/use_cases/definitions/kpi_retrieve_response.py">KpiRetrieveResponse</a></code>
+- <code title="put /api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}">client.use_cases.definitions.kpis.<a href="./src/payi/resources/use_cases/definitions/kpis.py">update</a>(kpi_name, \*, use_case_name, \*\*<a href="src/payi/types/use_cases/definitions/kpi_update_params.py">params</a>) -> <a href="./src/payi/types/use_cases/definitions/kpi_update_response.py">KpiUpdateResponse</a></code>
+- <code title="get /api/v1/use_cases/definitions/{use_case_name}/kpis">client.use_cases.definitions.kpis.<a href="./src/payi/resources/use_cases/definitions/kpis.py">list</a>(use_case_name, \*\*<a href="src/payi/types/use_cases/definitions/kpi_list_params.py">params</a>) -> <a href="./src/payi/types/use_cases/definitions/kpi_list_response.py">SyncCursorPage[KpiListResponse]</a></code>
+- <code title="delete /api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}">client.use_cases.definitions.kpis.<a href="./src/payi/resources/use_cases/definitions/kpis.py">delete</a>(kpi_name, \*, use_case_name) -> <a href="./src/payi/types/use_cases/definitions/kpi_delete_response.py">KpiDeleteResponse</a></code>
+
 ### LimitConfig
 
 Methods:

{payi-0.1.0a58 → payi-0.1.0a60}/pyproject.toml

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

{payi-0.1.0a58 → payi-0.1.0a60}/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.58"  # x-release-please-version
+__version__ = "0.1.0-alpha.60"  # x-release-please-version