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

payi/types/limit_list_params.py

@@ -2,25 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List
-from typing_extensions import Annotated, TypedDict
-
-from .._utils import PropertyInfo
+from typing_extensions import TypedDict
 
 __all__ = ["LimitListParams"]
 
 
 class LimitListParams(TypedDict, total=False):
-    limit_name: str
+    cursor: str
 
-    page_number: int
+    limit: int
 
-    page_size: int
+    limit_name: str
 
     sort_ascending: bool
-
-    sort_by: str
-
-    tag_list: Annotated[List[str], PropertyInfo(alias="TagList")]
-
-    tags: str

payi/types/limit_list_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .total_cost_data import TotalCostData
+
+__all__ = ["LimitListResponse"]
+
+
+class LimitListResponse(BaseModel):
+    limit_creation_timestamp: datetime
+
+    limit_id: str
+
+    limit_name: str
+
+    limit_type: Literal["block", "allow"]
+
+    limit_update_timestamp: datetime
+
+    max: float
+
+    totals: TotalCostData
+
+    limit_tags: Optional[List[str]] = None
+
+    threshold: Optional[float] = None

payi/types/use_cases/__init__.py

@@ -2,9 +2,12 @@
 
 from __future__ import annotations
 
+from .kpi_list_params import KpiListParams as KpiListParams
+from .kpi_create_params import KpiCreateParams as KpiCreateParams
+from .kpi_list_response import KpiListResponse as KpiListResponse
+from .kpi_update_params import KpiUpdateParams as KpiUpdateParams
 from .use_case_definition import UseCaseDefinition as UseCaseDefinition
 from .definition_list_params import DefinitionListParams as DefinitionListParams
 from .property_create_params import PropertyCreateParams as PropertyCreateParams
 from .definition_create_params import DefinitionCreateParams as DefinitionCreateParams
-from .definition_list_response import DefinitionListResponse as DefinitionListResponse
 from .definition_update_params import DefinitionUpdateParams as DefinitionUpdateParams

payi/types/use_cases/definition_list_params.py

@@ -8,5 +8,10 @@ __all__ = ["DefinitionListParams"]
 
 
 class DefinitionListParams(TypedDict, total=False):
+    cursor: str
+
+    limit: int
+
+    sort_ascending: bool
+
     use_case_name: str
-    """Use Case name"""

payi/types/use_cases/definitions/__init__.py

@@ -2,4 +2,12 @@
 
 from __future__ import annotations
 
+from .kpi_list_params import KpiListParams as KpiListParams
+from .kpi_create_params import KpiCreateParams as KpiCreateParams
+from .kpi_list_response import KpiListResponse as KpiListResponse
+from .kpi_update_params import KpiUpdateParams as KpiUpdateParams
+from .kpi_create_response import KpiCreateResponse as KpiCreateResponse
+from .kpi_delete_response import KpiDeleteResponse as KpiDeleteResponse
+from .kpi_update_response import KpiUpdateResponse as KpiUpdateResponse
+from .kpi_retrieve_response import KpiRetrieveResponse as KpiRetrieveResponse
 from .limit_config_create_params import LimitConfigCreateParams as LimitConfigCreateParams

payi/types/use_cases/definitions/kpi_create_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["KpiCreateParams"]
+
+
+class KpiCreateParams(TypedDict, total=False):
+    description: Required[str]
+
+    name: Required[str]
+
+    goal: float
+
+    kpi_type: Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]

payi/types/use_cases/definitions/kpi_create_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["KpiCreateResponse"]
+
+
+class KpiCreateResponse(BaseModel):
+    description: str
+
+    name: str
+
+    request_id: str
+
+    goal: Optional[float] = None
+
+    kpi_type: Optional[Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]] = None

payi/types/use_cases/definitions/kpi_delete_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["KpiDeleteResponse"]
+
+
+class KpiDeleteResponse(BaseModel):
+    description: str
+
+    name: str
+
+    request_id: str
+
+    goal: Optional[float] = None
+
+    kpi_type: Optional[Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]] = None

payi/types/use_cases/definitions/kpi_list_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["KpiListParams"]
+
+
+class KpiListParams(TypedDict, total=False):
+    cursor: str
+
+    kpi_name: str
+
+    limit: int
+
+    sort_ascending: bool

payi/types/use_cases/definitions/kpi_list_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["KpiListResponse"]
+
+
+class KpiListResponse(BaseModel):
+    description: str
+
+    name: str
+
+    request_id: str
+
+    goal: Optional[float] = None
+
+    kpi_type: Optional[Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]] = None

payi/types/use_cases/definitions/kpi_retrieve_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["KpiRetrieveResponse"]
+
+
+class KpiRetrieveResponse(BaseModel):
+    description: str
+
+    name: str
+
+    request_id: str
+
+    goal: Optional[float] = None
+
+    kpi_type: Optional[Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]] = None

payi/types/use_cases/definitions/kpi_update_params.py

@@ -0,0 +1,16 @@
+# 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 Required, TypedDict
+
+__all__ = ["KpiUpdateParams"]
+
+
+class KpiUpdateParams(TypedDict, total=False):
+    use_case_name: Required[str]
+
+    description: Optional[str]
+
+    goal: Optional[float]

payi/types/use_cases/definitions/kpi_update_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["KpiUpdateResponse"]
+
+
+class KpiUpdateResponse(BaseModel):
+    description: str
+
+    name: str
+
+    request_id: str
+
+    goal: Optional[float] = None
+
+    kpi_type: Optional[Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]] = None

payi/types/use_cases/kpi_create_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["KpiCreateParams"]
+
+
+class KpiCreateParams(TypedDict, total=False):
+    use_case_id: Required[str]
+
+    score: float

payi/types/use_cases/kpi_list_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["KpiListParams"]
+
+
+class KpiListParams(TypedDict, total=False):
+    cursor: str
+
+    kpi_name: str
+
+    limit: int
+
+    sort_ascending: bool

payi/types/use_cases/kpi_list_response.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["KpiListResponse"]
+
+
+class KpiListResponse(BaseModel):
+    kpi_name: Optional[str] = None
+
+    create_timestamp: Optional[datetime] = None
+
+    kpi_type: Optional[Literal["boolean", "number", "percentage", "likert5", "likert7", "likert10"]] = None
+
+    score: Optional[float] = None
+
+    update_timestamp: Optional[datetime] = None

payi/types/use_cases/kpi_update_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["KpiUpdateParams"]
+
+
+class KpiUpdateParams(TypedDict, total=False):
+    use_case_id: Required[str]
+
+    score: float

{payi-0.1.0a59.dist-info → payi-0.1.0a60.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a59
+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"))