payi 0.1.0a99__tar.gz → 0.1.0a101__tar.gz

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

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

{payi-0.1.0a99 → payi-0.1.0a101}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.0-alpha.101 (2025-07-18)
+
+Full Changelog: [v0.1.0-alpha.100...v0.1.0-alpha.101](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.100...v0.1.0-alpha.101)
+
+### Bug Fixes
+
+* properly merge use case state with parent context ([#344](https://github.com/Pay-i/pay-i-python/issues/344)) ([2a001f8](https://github.com/Pay-i/pay-i-python/commit/2a001f8c49a815c08494f08e1393e67728c6da48))
+
+## 0.1.0-alpha.100 (2025-07-16)
+
+Full Changelog: [v0.1.0-alpha.99...v0.1.0-alpha.100](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.99...v0.1.0-alpha.100)
+
+### Features
+
+* use cases and request property bags ([#342](https://github.com/Pay-i/pay-i-python/issues/342)) ([985209e](https://github.com/Pay-i/pay-i-python/commit/985209e1ac179ac7338d3845bd6498aa3d08afc3))
+
 ## 0.1.0-alpha.99 (2025-07-15)
 
 Full Changelog: [v0.1.0-alpha.98...v0.1.0-alpha.99](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.98...v0.1.0-alpha.99)

{payi-0.1.0a99 → payi-0.1.0a101}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a99
+Version: 0.1.0a101
 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.0a99 → payi-0.1.0a101}/pyproject.toml

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

{payi-0.1.0a99 → payi-0.1.0a101}/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.99"  # x-release-please-version
+__version__ = "0.1.0-alpha.101"  # x-release-please-version

{payi-0.1.0a99 → payi-0.1.0a101}/src/payi/lib/instrument.py

@@ -112,11 +112,16 @@ class _ProviderRequest:
                 except Exception as _ex:
                     pass
  
-        properties: 'dict[str,str]' = { "system.failure": exception_str }
+        existing_properties = self._ingest.get("properties", None)
+        if not existing_properties:
+            existing_properties = {}
+
+        existing_properties['system.failure'] = exception_str
         if fields:
             failure_description = ",".join(fields)
-            properties["system.failure.description"] = failure_description[:128]
-        self._ingest["properties"] = properties
+            existing_properties["system.failure.description"] = failure_description[:128]
+
+        self._ingest["properties"] = existing_properties
 
         if "http_status_code" not in self._ingest:
             # use a non existent http status code so when presented to the user, the origin is clear
@@ -150,17 +155,21 @@ class PayiInstrumentConfig(TypedDict, total=False):
     use_case_name: Optional[str]
     use_case_id: Optional[str]
     use_case_version: Optional[int]
+    use_case_properties: Optional["dict[str, str]"]
     user_id: Optional[str]
     request_tags: Optional["list[str]"]
+    request_properties: Optional["dict[str, str]"]
 
 class PayiContext(TypedDict, total=False):
     use_case_name: Optional[str]
     use_case_id: Optional[str]
     use_case_version: Optional[int]
     use_case_step: Optional[str]
+    use_case_properties: Optional["dict[str, str]"]
     limit_ids: Optional['list[str]']
     user_id: Optional[str]
     request_tags: Optional["list[str]"]
+    request_properties: Optional["dict[str, str]"]
     price_as_category: Optional[str]
     price_as_resource: Optional[str]
     resource_scope: Optional[str]
@@ -172,9 +181,11 @@ class _Context(TypedDict, total=False):
     use_case_id: Optional[str]
     use_case_version: Optional[int]
     use_case_step: Optional[str]
+    use_case_properties: Optional["dict[str, str]"]
     limit_ids: Optional['list[str]']
     user_id: Optional[str]
     request_tags: Optional["list[str]"]
+    request_properties: Optional["dict[str, str]"]
     price_as_category: Optional[str]
     price_as_resource: Optional[str]
     resource_scope: Optional[str]
@@ -645,6 +656,8 @@ class _PayiInstrumentor:
         use_case_step: Optional[str]= None,
         user_id: Optional[str]= None,
         request_tags: Optional["list[str]"] = None,
+        request_properties: Optional["dict[str, str]"] = None,
+        use_case_properties: Optional["dict[str, str]"] = None,
         price_as_category: Optional[str] = None,
         price_as_resource: Optional[str] = None,
         resource_scope: Optional[str] = None,
@@ -660,29 +673,58 @@ class _PayiInstrumentor:
         parent_use_case_name = parent_context.get("use_case_name", None)
         parent_use_case_id = parent_context.get("use_case_id", None)
         parent_use_case_version = parent_context.get("use_case_version", None)
+        parent_use_case_step = parent_context.get("use_case_step", None)
+
+        assign_use_case_values = False
 
         if use_case_name is None:
-            # If no use_case_name specified, use previous values
-            context["use_case_name"] = parent_use_case_name
-            context["use_case_id"] = parent_use_case_id
-            context["use_case_version"] = parent_use_case_version
+            if parent_use_case_name:
+                # If no use_case_name specified, use previous values
+                context["use_case_name"] = parent_use_case_name
+                assign_use_case_values = True
         elif len(use_case_name) == 0:
             # Empty string explicitly blocks inheriting from the parent state
             context["use_case_name"] = None
             context["use_case_id"] = None
             context["use_case_version"] = None
             context["use_case_step"] = None
+            context["use_case_properties"] = None
         else:
             if use_case_name == parent_use_case_name:
                 # Same use case name, use previous ID unless new one specified
                 context["use_case_name"] = use_case_name
-                context["use_case_id"] = use_case_id if use_case_id else parent_use_case_id
-                context["use_case_version"] = use_case_version if use_case_version else parent_use_case_version
             else:
-                # Different use case name, use specified ID or generate one
                 context["use_case_name"] = use_case_name
-                context["use_case_id"] = use_case_id if use_case_id else str(uuid.uuid4())
-                context["use_case_version"] = use_case_version if use_case_version else None
+
+                # Different use case name, use specified ID or generate one. 
+                # By assigning to a new value to parent_use_case_id we keep the assignment logic below simple and consistent with
+                # assign the caller's use_case_id if specified or the newly generated one. 
+                # The use case id stored in the parent context is not mutated.
+                parent_use_case_id = str(uuid.uuid4())
+
+            assign_use_case_values = True
+
+        if assign_use_case_values:
+            context["use_case_id"] = use_case_id if use_case_id else parent_use_case_id
+            context["use_case_version"] = use_case_version if use_case_version else parent_use_case_version
+            context["use_case_step"] = use_case_step if use_case_step else parent_use_case_step
+
+            parent_use_case_properties = parent_context.get("use_case_properties", None)
+            if use_case_properties is not None:
+                if not use_case_properties:
+                    # an empty dictionary explicitly blocks inheriting from the parent state
+                    context["use_case_properties"] = None
+                else:
+                    if parent_use_case_properties:
+                        # merge dictionaries, child overrides parent keys
+                        merged = parent_use_case_properties.copy()
+                        merged.update(use_case_properties)
+                        context["use_case_properties"] = merged
+                    else:
+                        context["use_case_properties"] = use_case_properties.copy()
+            elif parent_use_case_properties:
+                # use the parent use_case_properties if it exists
+                context["use_case_properties"] = parent_use_case_properties.copy()
 
         parent_limit_ids = parent_context.get("limit_ids", None)
         if limit_ids is None:
@@ -693,7 +735,7 @@ class _PayiInstrumentor:
             context["limit_ids"] = None
         else:
             # union of new and parent lists if the parent context contains limit ids
-            context["limit_ids"] = list(set(limit_ids) | set(parent_limit_ids)) if parent_limit_ids else limit_ids
+            context["limit_ids"] = list(set(limit_ids) | set(parent_limit_ids)) if parent_limit_ids else limit_ids.copy()
 
         parent_user_id = parent_context.get("user_id", None)
         if user_id is None:
@@ -708,19 +750,35 @@ class _PayiInstrumentor:
         parent_request_tags = parent_context.get("request_tags", None)
         if request_tags is not None:
             if len(request_tags) == 0:
+                # caller passing an empty list explicitly blocks inheriting from the parent state
                 context["request_tags"] = None
             else:
                 if parent_request_tags:
                     # union of new and parent lists if the parent context contains request tags
                     context["request_tags"] = list(set(request_tags) | set(parent_request_tags))
                 else:
-                    context["request_tags"] = request_tags
+                    context["request_tags"] = request_tags.copy()
         elif parent_request_tags:
             # use the parent request_tags if it exists
-            context["request_tags"] = parent_request_tags
+            context["request_tags"] = parent_request_tags.copy()
+
+        parent_request_properties = parent_context.get("request_properties", None)
+        if request_properties is not None:
+            if not request_properties:
+                # an empty dictionary explicitly blocks inheriting from the parent state
+                context["request_properties"] = None
+            else:
+                if parent_request_properties:
+                    # merge dictionaries, child overrides parent keys
+                    merged = parent_request_properties.copy()
+                    merged.update(request_properties)
+                    context["request_properties"] = merged
+                else:
+                    context["request_properties"] = request_properties.copy()
+        elif parent_request_properties:
+            # use the parent request_properties if it exists
+            context["request_properties"] = parent_request_properties.copy()
 
-        if use_case_step and (context["use_case_name"] or context["use_case_id"]):
-            context["use_case_step"] = use_case_step
         if price_as_category:
             context["price_as_category"] = price_as_category
         if price_as_resource:
@@ -738,6 +796,8 @@ class _PayiInstrumentor:
         use_case_version: Optional[int],        
         user_id: Optional[str],
         request_tags: Optional["list[str]"] = None,
+        request_properties: Optional["dict[str, str]"] = None,
+        use_case_properties: Optional["dict[str, str]"] = None,
         *args: Any,
         **kwargs: Any,
     ) -> Any:
@@ -749,7 +809,10 @@ class _PayiInstrumentor:
                 use_case_id=use_case_id,
                 use_case_version=use_case_version,
                 user_id=user_id,
-                request_tags=request_tags)
+                request_tags=request_tags,
+                request_properties=request_properties,
+                use_case_properties=use_case_properties
+            )
             return await func(*args, **kwargs)
 
     def _call_func(
@@ -762,6 +825,8 @@ class _PayiInstrumentor:
         use_case_version: Optional[int],        
         user_id: Optional[str],
         request_tags: Optional["list[str]"] = None,
+        request_properties: Optional["dict[str, str]"] = None,
+        use_case_properties: Optional["dict[str, str]"] = None,
         *args: Any,
         **kwargs: Any,
     ) -> Any:
@@ -773,7 +838,9 @@ class _PayiInstrumentor:
                 use_case_id=use_case_id,
                 use_case_version=use_case_version,
                 user_id=user_id,
-                request_tags=request_tags)
+                request_tags=request_tags,
+                request_properties=request_properties,
+                use_case_properties=use_case_properties)
             return func(*args, **kwargs)
 
     def __enter__(self) -> Any:
@@ -797,7 +864,8 @@ class _PayiInstrumentor:
     def _prepare_ingest(
         self,
         request: _ProviderRequest,
-        ingest_extra_headers: "dict[str, str]", # do not coflict potential kwargs["extra_headers"]
+        context: _Context,
+        ingest_extra_headers: "dict[str, str]", # do not conflict with potential kwargs["extra_headers"]
         args: Sequence[Any],
         kwargs: 'dict[str, Any]',
     ) -> None:
@@ -827,6 +895,14 @@ class _PayiInstrumentor:
         if user_id:
             request._ingest["user_id"] = user_id
 
+        request_properties = context.get("request_properties", None)
+        if request_properties:
+            request._ingest["properties"] = request_properties
+
+        use_case_properties = context.get("use_case_properties", None)
+        if use_case_properties:
+            request._ingest["use_case_properties"] = use_case_properties
+
         if len(ingest_extra_headers) > 0:
             request._ingest["provider_request_headers"] = [PayICommonModelsAPIRouterHeaderInfoParam(name=k, value=v) for k, v in ingest_extra_headers.items()]
 
@@ -909,7 +985,7 @@ class _PayiInstrumentor:
             stream = False
 
         try:
-            self._prepare_ingest(request, extra_headers, args, kwargs)
+            self._prepare_ingest(request, context, extra_headers, args, kwargs)
             self._logger.debug(f"async_invoke_wrapper: calling wrapped instance (stream={stream})")
 
             sw.start()
@@ -1032,7 +1108,7 @@ class _PayiInstrumentor:
             stream = False
 
         try:
-            self._prepare_ingest(request, extra_headers, args, kwargs)
+            self._prepare_ingest(request, context, extra_headers, args, kwargs)
             self._logger.debug(f"invoke_wrapper: calling wrapped instance (stream={stream})")
 
             sw.start()
@@ -1586,6 +1662,7 @@ global _instrumentor
 _instrumentor: Optional[_PayiInstrumentor] = None
 
 def payi_instrument(
+    *,
     payi: Optional[Union[Payi, AsyncPayi, 'list[Union[Payi, AsyncPayi]]']] = None,
     instruments: Optional[Set[str]] = None,
     log_prompt_and_response: bool = True,
@@ -1628,12 +1705,15 @@ def payi_instrument(
     )
 
 def track(
+    *,
     limit_ids: Optional["list[str]"] = None,
     use_case_name: Optional[str] = None,
     use_case_id: Optional[str] = None,
     use_case_version: Optional[int] = None,
     user_id: Optional[str] = None,
     request_tags: Optional["list[str]"] = None,
+    request_properties: Optional["dict[str, str]"] = None,
+    use_case_properties: Optional["dict[str, str]"] = None,
     proxy: Optional[bool] = None,
 ) -> Any:
 
@@ -1656,6 +1736,8 @@ def track(
                     use_case_version,
                     user_id,
                     request_tags,
+                    request_properties,
+                    use_case_properties,
                     *args,
                     **kwargs,
                 )
@@ -1677,6 +1759,8 @@ def track(
                     use_case_version,
                     user_id,
                     request_tags,
+                    request_properties,
+                    use_case_properties,
                     *args,
                     **kwargs,
                 )
@@ -1684,6 +1768,7 @@ def track(
     return _track
 
 def track_context(
+    *,
     limit_ids: Optional["list[str]"] = None,
     use_case_name: Optional[str] = None,
     use_case_id: Optional[str] = None,
@@ -1691,6 +1776,8 @@ def track_context(
     use_case_step: Optional[str] = None,
     user_id: Optional[str] = None,
     request_tags: Optional["list[str]"] = None,
+    request_properties: Optional["dict[str, str]"] = None,
+    use_case_properties: Optional["dict[str, str]"] = None,
     price_as_category: Optional[str] = None,
     price_as_resource: Optional[str] = None,
     resource_scope: Optional[str] = None,
@@ -1715,6 +1802,9 @@ def track_context(
     context["price_as_resource"] = price_as_resource
     context["resource_scope"] = resource_scope
 
+    context["request_properties"] = request_properties
+    context["use_case_properties"] = use_case_properties
+
     return _InternalTrackContext(context)
 
 def get_context() -> PayiContext:

{payi-0.1.0a99 → payi-0.1.0a101}/src/payi/resources/ingest.py

@@ -90,7 +90,6 @@ class IngestResource(SyncAPIResource):
         units: Dict[str, IngestUnits],
         end_to_end_latency_ms: Optional[int] | NotGiven = NOT_GIVEN,
         event_timestamp: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
-        experience_properties: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         http_status_code: Optional[int] | NotGiven = NOT_GIVEN,
         properties: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         provider_request_headers: Optional[Iterable[PayICommonModelsAPIRouterHeaderInfoParam]] | NotGiven = NOT_GIVEN,
@@ -133,11 +132,13 @@ class IngestResource(SyncAPIResource):
 
           output (int): The number of output units
 
-          event_timestamp: (str, datetime, None): The timestamp of the event. Defaults to None.
+          event_timestamp: (str, datetime, None): The timestamp of the event
 
-          limit_ids (list[str], optional): The limit IDs to associate with the request. Defaults to None.
+          limit_ids (list[str], optional): The limit IDs to associate with the request
 
-          request_tags (list[str], optional): The request tags to associate with the request. Defaults to None.
+          properties (Dict[str, str], optional): Properties to associate with the request
+
+          request_tags (list[str], optional): The request tags to associate with the request
 
           use_case_name (str, optional): The use case name
 
@@ -147,6 +148,8 @@ class IngestResource(SyncAPIResource):
 
           use_case_version (int, optional): The use case instance version
 
+          use_case_properties (Dict[str, str], optional): The use case properties
+
           user_id (str, optional): The user id
           
           resource_scope(str, optional): The scope of the resource
@@ -234,7 +237,6 @@ class IngestResource(SyncAPIResource):
                     "units": units,
                     "end_to_end_latency_ms": end_to_end_latency_ms,
                     "event_timestamp": event_timestamp,
-                    "experience_properties": experience_properties,
                     "http_status_code": http_status_code,
                     "properties": properties,
                     "provider_request_headers": provider_request_headers,
@@ -318,7 +320,6 @@ class AsyncIngestResource(AsyncAPIResource):
         units: Dict[str, IngestUnits],
         end_to_end_latency_ms: Optional[int] | NotGiven = NOT_GIVEN,
         event_timestamp: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
-        experience_properties: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         http_status_code: Optional[int] | NotGiven = NOT_GIVEN,
         properties: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         provider_request_headers: Optional[Iterable[PayICommonModelsAPIRouterHeaderInfoParam]] | NotGiven = NOT_GIVEN,
@@ -360,11 +361,13 @@ class AsyncIngestResource(AsyncAPIResource):
 
           output (int): The number of output units
 
-          event_timestamp: (datetime, None): The timestamp of the event. Defaults to None.
+          event_timestamp: (datetime, None): The timestamp of the event
 
-          limit_ids (list[str], optional): The limit IDs to associate with the request. Defaults to None.
+          limit_ids (list[str], optional): The limit IDs to associate with the request 
 
-          request_tags (list[str], optional): The request tags to associate with the request. Defaults to None.
+          properties (Dict[str, str], optional): Properties to associate with the request 
+
+          request_tags (list[str], optional): The request tags to associate with the request
 
           use_case_name (str, optional): The use case name
 
@@ -374,6 +377,8 @@ class AsyncIngestResource(AsyncAPIResource):
 
           use_case_version (int, optional): The use case instance version
 
+          use_case_properties (Dict[str, str], optional): The use case properties
+
           user_id (str, optional): The user id
           
           resource_scope (str, optional): The scope of the resource
@@ -460,7 +465,6 @@ class AsyncIngestResource(AsyncAPIResource):
                     "units": units,
                     "end_to_end_latency_ms": end_to_end_latency_ms,
                     "event_timestamp": event_timestamp,
-                    "experience_properties": experience_properties,
                     "http_status_code": http_status_code,
                     "properties": properties,
                     "provider_request_headers": provider_request_headers,

{payi-0.1.0a99 → payi-0.1.0a101}/src/payi/types/ingest_units_params.py

@@ -24,8 +24,6 @@ class IngestUnitsParams(TypedDict, total=False):
 
     event_timestamp: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
 
-    experience_properties: Optional[Dict[str, str]]
-
     http_status_code: Optional[int]
 
     properties: Optional[Dict[str, str]]

{payi-0.1.0a99 → payi-0.1.0a101}/tests/api_resources/test_ingest.py

@@ -40,7 +40,6 @@ class TestIngest:
                     "event_timestamp": parse_datetime("2019-12-27T18:11:19.117Z"),
                     "experience_id": "experience_id",
                     "experience_name": "experience_name",
-                    "experience_properties": {"foo": "string"},
                     "experience_version": 0,
                     "http_status_code": 0,
                     "limit_ids": ["string"],
@@ -124,7 +123,6 @@ class TestIngest:
             },
             end_to_end_latency_ms=0,
             event_timestamp=parse_datetime("2019-12-27T18:11:19.117Z"),
-            experience_properties={"foo": "string"},
             http_status_code=0,
             properties={"foo": "string"},
             provider_request_headers=[
@@ -221,7 +219,6 @@ class TestAsyncIngest:
                     "event_timestamp": parse_datetime("2019-12-27T18:11:19.117Z"),
                     "experience_id": "experience_id",
                     "experience_name": "experience_name",
-                    "experience_properties": {"foo": "string"},
                     "experience_version": 0,
                     "http_status_code": 0,
                     "limit_ids": ["string"],
@@ -305,7 +302,6 @@ class TestAsyncIngest:
             },
             end_to_end_latency_ms=0,
             event_timestamp=parse_datetime("2019-12-27T18:11:19.117Z"),
-            experience_properties={"foo": "string"},
             http_status_code=0,
             properties={"foo": "string"},
             provider_request_headers=[

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

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