payi 0.1.0a23__py3-none-any.whl → 0.1.0a25__py3-none-any.whl

payi/resources/experiences/types.py

@@ -2,8 +2,6 @@
 
 from __future__ import annotations
 
-from typing import Optional
-
 import httpx
 
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
@@ -20,7 +18,7 @@ from ..._response import (
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
-from ...types.experiences import type_create_params, type_update_params
+from ...types.experiences import type_list_params, type_create_params, type_update_params
 from ...types.experiences.experience_type import ExperienceType
 from ...types.experiences.type_list_response import TypeListResponse
 
@@ -30,10 +28,21 @@ __all__ = ["TypesResource", "AsyncTypesResource"]
 class TypesResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> TypesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
+        """
         return TypesResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> TypesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#with_streaming_response
+        """
         return TypesResourceWithStreamingResponse(self)
 
     def create(
@@ -49,7 +58,7 @@ class TypesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ExperienceType:
         """
-        Create an Experience Type
+        Create an new Experience Type
 
         Args:
           extra_headers: Send extra headers
@@ -77,7 +86,7 @@ class TypesResource(SyncAPIResource):
 
     def retrieve(
         self,
-        experience_type_id: str,
+        experience_name: str,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -98,10 +107,10 @@ class TypesResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not experience_type_id:
-            raise ValueError(f"Expected a non-empty value for `experience_type_id` but received {experience_type_id!r}")
+        if not experience_name:
+            raise ValueError(f"Expected a non-empty value for `experience_name` but received {experience_name!r}")
         return self._get(
-            f"/api/v1/experiences/types/{experience_type_id}",
+            f"/api/v1/experiences/types/{experience_name}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -110,10 +119,9 @@ class TypesResource(SyncAPIResource):
 
     def update(
         self,
-        experience_type_id: str,
+        experience_name: str,
         *,
-        description: Optional[str] | NotGiven = NOT_GIVEN,
-        name: Optional[str] | NotGiven = NOT_GIVEN,
+        description: str,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -133,17 +141,11 @@ class TypesResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not experience_type_id:
-            raise ValueError(f"Expected a non-empty value for `experience_type_id` but received {experience_type_id!r}")
+        if not experience_name:
+            raise ValueError(f"Expected a non-empty value for `experience_name` but received {experience_name!r}")
         return self._patch(
-            f"/api/v1/experiences/types/{experience_type_id}",
-            body=maybe_transform(
-                {
-                    "description": description,
-                    "name": name,
-                },
-                type_update_params.TypeUpdateParams,
-            ),
+            f"/api/v1/experiences/types/{experience_name}",
+            body=maybe_transform({"description": description}, type_update_params.TypeUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -153,6 +155,7 @@ class TypesResource(SyncAPIResource):
     def list(
         self,
         *,
+        name: str | 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,
@@ -160,18 +163,35 @@ class TypesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TypeListResponse:
-        """Get all Experience Types"""
+        """
+        Get all Experience Types
+
+        Args:
+          name: Experience Type Name
+
+          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/v1/experiences/types",
             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({"name": name}, type_list_params.TypeListParams),
             ),
             cast_to=TypeListResponse,
         )
 
     def delete(
         self,
-        experience_type_id: str,
+        experience_name: str,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -192,10 +212,10 @@ class TypesResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not experience_type_id:
-            raise ValueError(f"Expected a non-empty value for `experience_type_id` but received {experience_type_id!r}")
+        if not experience_name:
+            raise ValueError(f"Expected a non-empty value for `experience_name` but received {experience_name!r}")
         return self._delete(
-            f"/api/v1/experiences/types/{experience_type_id}",
+            f"/api/v1/experiences/types/{experience_name}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -206,10 +226,21 @@ class TypesResource(SyncAPIResource):
 class AsyncTypesResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncTypesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncTypesResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncTypesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#with_streaming_response
+        """
         return AsyncTypesResourceWithStreamingResponse(self)
 
     async def create(
@@ -225,7 +256,7 @@ class AsyncTypesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ExperienceType:
         """
-        Create an Experience Type
+        Create an new Experience Type
 
         Args:
           extra_headers: Send extra headers
@@ -253,7 +284,7 @@ class AsyncTypesResource(AsyncAPIResource):
 
     async def retrieve(
         self,
-        experience_type_id: str,
+        experience_name: str,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -274,10 +305,10 @@ class AsyncTypesResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not experience_type_id:
-            raise ValueError(f"Expected a non-empty value for `experience_type_id` but received {experience_type_id!r}")
+        if not experience_name:
+            raise ValueError(f"Expected a non-empty value for `experience_name` but received {experience_name!r}")
         return await self._get(
-            f"/api/v1/experiences/types/{experience_type_id}",
+            f"/api/v1/experiences/types/{experience_name}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -286,10 +317,9 @@ class AsyncTypesResource(AsyncAPIResource):
 
     async def update(
         self,
-        experience_type_id: str,
+        experience_name: str,
         *,
-        description: Optional[str] | NotGiven = NOT_GIVEN,
-        name: Optional[str] | NotGiven = NOT_GIVEN,
+        description: str,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -309,17 +339,11 @@ class AsyncTypesResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not experience_type_id:
-            raise ValueError(f"Expected a non-empty value for `experience_type_id` but received {experience_type_id!r}")
+        if not experience_name:
+            raise ValueError(f"Expected a non-empty value for `experience_name` but received {experience_name!r}")
         return await self._patch(
-            f"/api/v1/experiences/types/{experience_type_id}",
-            body=await async_maybe_transform(
-                {
-                    "description": description,
-                    "name": name,
-                },
-                type_update_params.TypeUpdateParams,
-            ),
+            f"/api/v1/experiences/types/{experience_name}",
+            body=await async_maybe_transform({"description": description}, type_update_params.TypeUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -329,6 +353,7 @@ class AsyncTypesResource(AsyncAPIResource):
     async def list(
         self,
         *,
+        name: str | 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,
@@ -336,18 +361,35 @@ class AsyncTypesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TypeListResponse:
-        """Get all Experience Types"""
+        """
+        Get all Experience Types
+
+        Args:
+          name: Experience Type Name
+
+          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 await self._get(
             "/api/v1/experiences/types",
             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=await async_maybe_transform({"name": name}, type_list_params.TypeListParams),
             ),
             cast_to=TypeListResponse,
         )
 
     async def delete(
         self,
-        experience_type_id: str,
+        experience_name: str,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -368,10 +410,10 @@ class AsyncTypesResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not experience_type_id:
-            raise ValueError(f"Expected a non-empty value for `experience_type_id` but received {experience_type_id!r}")
+        if not experience_name:
+            raise ValueError(f"Expected a non-empty value for `experience_name` but received {experience_name!r}")
         return await self._delete(
-            f"/api/v1/experiences/types/{experience_type_id}",
+            f"/api/v1/experiences/types/{experience_name}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

payi/resources/ingest.py

@@ -33,10 +33,21 @@ __all__ = ["IngestResource", "AsyncIngestResource"]
 class IngestResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> IngestResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
+        """
         return IngestResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> IngestResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#with_streaming_response
+        """
         return IngestResourceWithStreamingResponse(self)
 
     def bulk(
@@ -183,10 +194,21 @@ class IngestResource(SyncAPIResource):
 class AsyncIngestResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncIngestResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncIngestResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncIngestResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Pay-i/pay-i-python#with_streaming_response
+        """
         return AsyncIngestResourceWithStreamingResponse(self)
 
     async def bulk(

payi/types/__init__.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from .shared import EvaluationResponse as EvaluationResponse
 from .cost_data import CostData as CostData
 from .cost_details import CostDetails as CostDetails
 from .requests_data import RequestsData as RequestsData

payi/types/category_delete_response.py

@@ -1,10 +1,10 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List
+from typing import List
 from typing_extensions import TypeAlias
 
 from .category_resource_response import CategoryResourceResponse
 
 __all__ = ["CategoryDeleteResponse"]
 
-CategoryDeleteResponse: TypeAlias = Dict[str, List[CategoryResourceResponse]]
+CategoryDeleteResponse: TypeAlias = List[CategoryResourceResponse]

payi/types/evaluations/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .request_create_params import RequestCreateParams as RequestCreateParams
+from .experience_create_params import ExperienceCreateParams as ExperienceCreateParams

payi/types/evaluations/experience_create_params.py

@@ -0,0 +1,14 @@
+# 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__ = ["ExperienceCreateParams"]
+
+
+class ExperienceCreateParams(TypedDict, total=False):
+    evaluation: Required[int]
+
+    user_id: Optional[str]

payi/types/evaluations/request_create_params.py

@@ -0,0 +1,14 @@
+# 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__ = ["RequestCreateParams"]
+
+
+class RequestCreateParams(TypedDict, total=False):
+    evaluation: Required[int]
+
+    user_id: Optional[str]

payi/types/experiences/__init__.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from .experience_type import ExperienceType as ExperienceType
+from .type_list_params import TypeListParams as TypeListParams
 from .type_create_params import TypeCreateParams as TypeCreateParams
 from .type_list_response import TypeListResponse as TypeListResponse
 from .type_update_params import TypeUpdateParams as TypeUpdateParams

payi/types/experiences/experience_type.py

@@ -10,8 +10,6 @@ __all__ = ["ExperienceType"]
 class ExperienceType(BaseModel):
     description: str
 
-    experience_type_id: str
-
     name: str
 
     request_id: str

payi/types/experiences/type_list_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["TypeListParams"]
+
+
+class TypeListParams(TypedDict, total=False):
+    name: str
+    """Experience Type Name"""

payi/types/experiences/type_update_params.py

@@ -2,13 +2,10 @@
 
 from __future__ import annotations
 
-from typing import Optional
-from typing_extensions import TypedDict
+from typing_extensions import Required, TypedDict
 
 __all__ = ["TypeUpdateParams"]
 
 
 class TypeUpdateParams(TypedDict, total=False):
-    description: Optional[str]
-
-    name: Optional[str]
+    description: Required[str]

payi/types/requests_data.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+
 
 from .._models import BaseModel
 
@@ -10,8 +10,12 @@ __all__ = ["RequestsData"]
 class RequestsData(BaseModel):
     blocked: int
 
-    error: int
+    blocked_external: int
+
+    exceeded: int
+
+    failed: int
 
-    successful: int
+    ok: int
 
-    total: Optional[int] = None
+    total: int

payi/types/shared/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .evaluation_response import EvaluationResponse as EvaluationResponse

payi/types/shared/evaluation_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+
+
+from ..._models import BaseModel
+
+__all__ = ["EvaluationResponse"]
+
+
+class EvaluationResponse(BaseModel):
+    request_id: str

payi/types/total_cost_data.py

@@ -1,31 +1,15 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+
 
 from .._models import BaseModel
 from .cost_data import CostData
 from .requests_data import RequestsData
 
-__all__ = ["TotalCostData", "BudgetTransactions"]
-
-
-class BudgetTransactions(BaseModel):
-    blocked: int
-
-    blocked_external: int
-
-    exceeded: int
-
-    successful: int
-
-    error: Optional[int] = None
-
-    total: Optional[int] = None
+__all__ = ["TotalCostData"]
 
 
 class TotalCostData(BaseModel):
     cost: CostData
 
     requests: RequestsData
-
-    budget_transactions: Optional[BudgetTransactions] = None

{payi-0.1.0a23.dist-info → payi-0.1.0a25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a23
+Version: 0.1.0a25
 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
@@ -356,6 +356,17 @@ We take backwards-compatibility seriously and work hard to ensure you can rely o
 
 We are keen for your feedback; please open an [issue](https://www.github.com/Pay-i/pay-i-python/issues) with questions, bugs, or suggestions.
 
+### Determining the installed version
+
+If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
+
+You can determine the version that is being used at runtime with:
+
+```py
+import payi
+print(payi.__version__)
+```
+
 ## Requirements
 
 Python 3.7 or higher.