runapi-core 0.8.3__tar.gz → 0.9.1__tar.gz

{runapi_core-0.8.3 → runapi_core-0.9.1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.5
 Name: runapi-core
-Version: 0.8.3
+Version: 0.9.1
 Summary: RunAPI core SDK for JavaScript, Python, Ruby, Go, Java, and PHP
 Project-URL: Homepage, https://runapi.ai/models
 Project-URL: Documentation, https://runapi.ai/docs/resources/sdks
 Project-URL: Source, https://github.com/runapi-ai/core-sdk
 Project-URL: Issues, https://github.com/runapi-ai/core-sdk/issues
 Project-URL: Changelog, https://github.com/runapi-ai/core-sdk/blob/main/CHANGELOG.md
-Project-URL: Release Notes, https://github.com/runapi-ai/core-sdk/releases/tag/python%2Fv0.8.3
+Project-URL: Release Notes, https://github.com/runapi-ai/core-sdk/releases/tag/python%2Fv0.9.1
 Author-email: RunAPI <contact@runapi.ai>
 License-Expression: Apache-2.0
 Keywords: api,core,golang,gradle,java,maven,pypi,python,ruby,runapi,runapi-ai,sdk,typescript
@@ -134,7 +134,7 @@ quote = client.pricing.create_quote(
 )
 ```
 
-Task responses expose persisted billing facts at `response.billing`: `reservation`, `settlement`, and `refund` are typed objects when recorded and `None` when the historical fact is absent. These facts describe that Task and are not recalculated from the current schedule.
+Completed Task query and webhook envelopes expose `usage.cost` as a float USD amount for that Task. Create, processing, and failed envelopes omit `usage`. The value is the recorded settlement for that Task and is never recalculated from the current price schedule.
 
 ## License
 

{runapi_core-0.8.3 → runapi_core-0.9.1}/README.md

@@ -117,7 +117,7 @@ quote = client.pricing.create_quote(
 )
 ```
 
-Task responses expose persisted billing facts at `response.billing`: `reservation`, `settlement`, and `refund` are typed objects when recorded and `None` when the historical fact is absent. These facts describe that Task and are not recalculated from the current schedule.
+Completed Task query and webhook envelopes expose `usage.cost` as a float USD amount for that Task. Create, processing, and failed envelopes omit `usage`. The value is the recorded settlement for that Task and is never recalculated from the current price schedule.
 
 ## License
 

{runapi_core-0.8.3 → runapi_core-0.9.1}/pyproject.toml

@@ -19,7 +19,7 @@ Documentation = "https://runapi.ai/docs/resources/sdks"
 Source = "https://github.com/runapi-ai/core-sdk"
 Issues = "https://github.com/runapi-ai/core-sdk/issues"
 Changelog = "https://github.com/runapi-ai/core-sdk/blob/main/CHANGELOG.md"
-"Release Notes" = "https://github.com/runapi-ai/core-sdk/releases/tag/python%2Fv0.8.3"
+"Release Notes" = "https://github.com/runapi-ai/core-sdk/releases/tag/python%2Fv0.9.1"
 
 [tool.hatch.version]
 path = "src/runapi/core/version.py"

{runapi_core-0.8.3 → runapi_core-0.9.1}/src/runapi/core/__init__.py

@@ -29,14 +29,11 @@ from .files import DeletedFile, FileList, FileObject, FilesClient, UploadRespons
 from .http_client import HttpClient
 from .models import (
     BaseModel,
-    BillingRefund,
-    BillingReservation,
-    BillingSettlement,
     DynamicModel,
-    TaskBillingFacts,
     TaskResult,
     TaskResultResponse,
     TaskResponse,
+    TaskUsage,
     optional,
     required,
 )
@@ -86,10 +83,7 @@ __all__ = [
     "TaskResponse",
     "TaskResult",
     "TaskResultResponse",
-    "BillingReservation",
-    "BillingSettlement",
-    "BillingRefund",
-    "TaskBillingFacts",
+    "TaskUsage",
     "required",
     "optional",
     "MultipartBody",

{runapi_core-0.8.3 → runapi_core-0.9.1}/src/runapi/core/contract_gen.py

@@ -2109,11 +2109,31 @@ CONTRACT = {
     "suno/remaster-audio": {
         "models": ["suno-v4", "suno-v4.5", "suno-v4.5-plus", "suno-v5", "suno-v5.5"],
         "fields_by_model": {
-            "suno-v4": {},
-            "suno-v4.5": {},
-            "suno-v4.5-plus": {},
-            "suno-v5": {},
-            "suno-v5.5": {}
+            "suno-v4": {
+                "variation_category": {
+                    "enum": ["subtle", "normal", "high"]
+                }
+            },
+            "suno-v4.5": {
+                "variation_category": {
+                    "enum": ["subtle", "normal", "high"]
+                }
+            },
+            "suno-v4.5-plus": {
+                "variation_category": {
+                    "enum": ["subtle", "normal", "high"]
+                }
+            },
+            "suno-v5": {
+                "variation_category": {
+                    "enum": ["subtle", "normal", "high"]
+                }
+            },
+            "suno-v5.5": {
+                "variation_category": {
+                    "enum": ["subtle", "normal", "high"]
+                }
+            }
         }
     },
     "suno/replace-section": {
@@ -2322,6 +2342,16 @@ CONTRACT = {
             }
         }
     },
+    "typesafe/system-one": {
+        "models": ["jev-latest"],
+        "fields_by_model": {
+            "jev-latest": {
+                "model": {
+                    "enum": ["jev-latest"]
+                }
+            }
+        }
+    },
     "veo-3-1/extend-video": {
         "models": [],
         "fields_by_model": {
@@ -2429,6 +2459,9 @@ CONTRACT = {
                 }
             },
             "wan-2.5-image-to-video": {
+                "duration_seconds": {
+                    "enum": [5, 10]
+                },
                 "output_resolution": {
                     "enum": ["720p", "1080p"]
                 }
@@ -2493,6 +2526,9 @@ CONTRACT = {
                 }
             },
             "wan-2.5-text-to-video": {
+                "duration_seconds": {
+                    "enum": [5, 10]
+                },
                 "output_resolution": {
                     "enum": ["720p", "1080p"]
                 }

{runapi_core-0.8.3 → runapi_core-0.9.1}/src/runapi/core/models.py

@@ -263,7 +263,7 @@ class TaskResponse(BaseModel):
     id = optional(str)
     status = optional(str)
     error = optional(str)
-    billing = optional(lambda: TaskBillingFacts)
+    usage = optional(lambda: TaskUsage)
 
 
 class TaskResultResponse(BaseModel):
@@ -275,28 +275,16 @@ class TaskResultResponse(BaseModel):
     body = optional()
 
 
-class TaskResult(TaskResponse):
+class TaskResult(BaseModel):
     """The account-scoped Task Result resource returned from an opaque Location."""
 
+    Status = TaskResponse.Status
+
     id = required(str)
-    status = required(str, enum=lambda: TaskResponse.Status.ALL)
+    status = required(str, enum=lambda: TaskResult.Status.ALL)
+    error = optional(str)
     response = optional(lambda: TaskResultResponse)
 
 
-class BillingReservation(BaseModel):
-    amount_cents = required(int)
-
-
-class BillingSettlement(BaseModel):
-    charged_amount_cents = required(int)
-    amount_micro_cents = required(int)
-
-
-class BillingRefund(BaseModel):
-    refunded_at = required(str)
-
-
-class TaskBillingFacts(BaseModel):
-    reservation = optional(BillingReservation)
-    settlement = optional(BillingSettlement)
-    refund = optional(BillingRefund)
+class TaskUsage(BaseModel):
+    cost = required(float)

{runapi_core-0.8.3 → runapi_core-0.9.1}/src/runapi/core/resource.py

@@ -227,7 +227,7 @@ class Resource:
 
         enum = rules.get("enum")
         if enum is not None and not self._enum_allowed(enum, value):
-            raise ValidationError(f"{field} must be one of: {', '.join(str(option) for option in enum)}")
+            raise ValidationError(f"{field} must be one of: {', '.join(self._message_value(option) for option in enum)}")
 
         if rules.get("type") == "integer":
             self._validate_integer(field, value, rules)
@@ -318,8 +318,9 @@ class Resource:
         ):
             return
 
+        # Sorted so the message matches every other SDK; Go maps have no declaration order.
         context = " and ".join(
-            self._rule_condition_label(key, val) for key, val in conditions.items()
+            self._rule_condition_label(key, conditions[key]) for key in sorted(conditions)
         )
         qualifier = f" when {context}" if context else ""
 
@@ -335,12 +336,14 @@ class Resource:
             if self._field_present(params, field):
                 raise ValidationError(f"{field} is not allowed{qualifier}")
 
-        for field, allowed in (rule.get("enum") or {}).items():
+        narrowed = rule.get("enum") or {}
+        for field in sorted(narrowed):
+            allowed = narrowed[field]
             if not self._field_present(params, field):
                 continue
             if any(str(candidate) == str(params[field]) for candidate in allowed):
                 continue
-            joined = ", ".join(str(candidate) for candidate in allowed)
+            joined = ", ".join(self._message_value(candidate) for candidate in allowed)
             raise ValidationError(f"{field} must be one of: {joined}{qualifier}")
 
     def _rule_condition_met(self, params: Dict[str, Any], field: str, condition: Any) -> bool:
@@ -360,7 +363,14 @@ class Resource:
     def _rule_condition_label(self, field: str, condition: Any) -> str:
         if self._is_presence_condition(condition):
             return f"{field} is present" if condition["present"] is True else f"{field} is absent"
-        return f"{field} is {condition}"
+        return f"{field} is {self._message_value(condition)}"
+
+    @staticmethod
+    def _message_value(value: Any) -> str:
+        """Render booleans as JSON does (``false``) to match the other SDKs."""
+        if isinstance(value, bool):
+            return "true" if value else "false"
+        return str(value)
 
     @classmethod
     def _field_present(cls, params: Dict[str, Any], field: str) -> bool:

runapi_core-0.9.1/src/runapi/core/version.py

@@ -0,0 +1 @@
+__version__ = "0.9.1"

runapi_core-0.9.1/tests/test_contract_rule_messages.py

@@ -0,0 +1,28 @@
+"""Rule messages must match every other SDK (sdk/contract_rule_messages.json)."""
+
+import json
+from pathlib import Path
+
+import pytest
+
+from runapi.core import Resource
+from runapi.core.errors import ValidationError
+
+SDK_ROOT = Path(__file__).resolve().parents[4]
+FIXTURE = SDK_ROOT / "contract_rule_messages.json"
+CONTRACT = SDK_ROOT / "contract.json"
+
+# The shared fixture lives in the SDK monorepo; the public package repo does not ship it.
+pytestmark = pytest.mark.skipif(not FIXTURE.exists(), reason="shared SDK fixture not available")
+
+CASES = json.loads(FIXTURE.read_text())["cases"] if FIXTURE.exists() else []
+
+
+@pytest.mark.parametrize("case", CASES, ids=[case["name"] for case in CASES])
+def test_rule_message_matches_shared_fixture(case):
+    schema = json.loads(CONTRACT.read_text())["actions"][case["action"]]
+
+    with pytest.raises(ValidationError) as error:
+        Resource(object())._validate_contract(schema, dict(case["params"]))
+
+    assert str(error.value) == case["message"]

{runapi_core-0.8.3 → runapi_core-0.9.1}/tests/test_models.py

@@ -1,6 +1,6 @@
 import pytest
 
-from runapi.core import BaseModel, DynamicModel, TaskBillingFacts, TaskResponse, optional, required
+from runapi.core import BaseModel, DynamicModel, TaskResult, TaskResponse, TaskUsage, optional, required
 from runapi.core.errors import ValidationError
 
 
@@ -34,7 +34,7 @@ def test_required_field_missing_raises():
 
 
 def test_item_and_dot_access():
-    model = Sample({"id": "abc", "status": "completed"})
+    model = Sample({"id": "abc", "status": "completed", "usage": {"cost": 0.05}})
     assert model["id"] == "abc"
     assert model.status == "completed"
 
@@ -45,8 +45,7 @@ def test_coerces_nested_hashes_and_arrays():
             "id": "abc",
             "meta": {"count": 2},
             "items": [{"name": "first"}],
-            "extra_field": {"nested": True},
-        }
+            "extra_field": {"nested": True}}
     )
     assert isinstance(model.meta, DynamicModel)
     assert model.meta.count == 2
@@ -70,8 +69,8 @@ def test_to_dict_serializes_recursively():
 
 
 def test_equality_with_dict():
-    model = Sample({"id": "abc", "status": "completed"})
-    assert model == {"id": "abc", "status": "completed"}
+    model = Sample({"id": "abc", "status": "completed", "usage": {"cost": 0.05}})
+    assert model == {"id": "abc", "status": "completed", "usage": {"cost": 0.05}}
 
 
 def test_optional_absent_field_is_none():
@@ -119,14 +118,32 @@ def test_response_headers_stay_outside_serialized_body():
     assert model.to_dict() == {"id": "abc"}
 
 
-def test_task_response_coerces_typed_billing_facts_and_preserves_unknown_fields():
+def test_task_response_coerces_typed_usage_and_preserves_unknown_fields():
     response = TaskResponse(
         {
             "id": "task_1",
-            "billing": {"reservation": {"amount_cents": 5}, "future_fact": "retained"},
-        }
+            "status": "completed",
+            "usage": {"cost": 0.05, "future_fact": "retained"}}
     )
 
-    assert isinstance(response.billing, TaskBillingFacts)
-    assert response.billing.reservation.amount_cents == 5
-    assert response.billing.future_fact == "retained"
+    assert isinstance(response.usage, TaskUsage)
+    assert response.usage.cost == 0.05
+    assert response.usage.future_fact == "retained"
+
+
+def test_task_result_preserves_public_status_constants_without_task_usage():
+    assert [
+        TaskResult.Status.PENDING,
+        TaskResult.Status.PROCESSING,
+        TaskResult.Status.COMPLETED,
+        TaskResult.Status.FAILED,
+    ] == ["pending", "processing", "completed", "failed"]
+
+    result = TaskResult({"id": "task_1", "status": TaskResult.Status.COMPLETED})
+    assert result.status == "completed"
+    assert "usage" not in result.to_dict()
+    with pytest.raises(AttributeError):
+        _ = result.usage
+
+    with pytest.raises(ValidationError, match="Invalid status"):
+        TaskResult({"id": "task_1", "status": "unknown"})

{runapi_core-0.8.3 → runapi_core-0.9.1}/tests/test_resource.py

@@ -91,10 +91,8 @@ INT_SCHEMA = {
     "fields_by_model": {
         "m": {
             "duration_int": {"type": "integer", "min": 4, "max": 12},
-            "tolerance": {"type": "integer"},
-        }
-    },
-}
+            "tolerance": {"type": "integer"}}
+    }}
 
 
 def _run_validate(params):
@@ -130,10 +128,8 @@ def test_validate_functional_action_uses_underscore_fields():
         "fields_by_model": {
             "_": {
                 "prompt": {"required": True},
-                "mode": {"enum": ["fast", "quality"]},
-            }
-        },
-    }
+                "mode": {"enum": ["fast", "quality"]}}
+        }}
     resource._validate_contract(schema, {"prompt": "hello", "mode": "fast"})
     with pytest.raises(ValidationError, match="prompt is required"):
         resource._validate_contract(schema, {"mode": "fast"})
@@ -155,7 +151,7 @@ def test_validate_boolean_enum_requires_boolean_value():
 
     resource._validate_contract(schema, {"model": "m", "flag": True})
     resource._validate_contract(schema, {"model": "m", "flag": False})
-    with pytest.raises(ValidationError, match="^flag must be one of: True, False$"):
+    with pytest.raises(ValidationError, match="^flag must be one of: true, false$"):
         resource._validate_contract(schema, {"model": "m", "flag": "true"})
 
 
@@ -164,10 +160,8 @@ def test_validate_array_item_count_constraints():
         "models": ["m"],
         "fields_by_model": {
             "m": {
-                "reference_image_urls": {"min_items": 1, "max_items": 3},
-            }
-        },
-    }
+                "reference_image_urls": {"min_items": 1, "max_items": 3}}
+        }}
     resource = SampleResource(FakeHttp())
 
     with pytest.raises(ValidationError, match="^reference_image_urls must be an array$"):
@@ -187,8 +181,7 @@ def test_validate_contract_runs_rules_before_field_requirements():
     schema = {
         "models": ["m"],
         "rules": [{"when": {"model": "m"}, "forbidden": ["source_task_id"]}],
-        "fields_by_model": {"m": {"source_image_urls": {"required": True}}},
-    }
+        "fields_by_model": {"m": {"source_image_urls": {"required": True}}}}
     resource = SampleResource(FakeHttp())
     with pytest.raises(ValidationError, match="source_task_id is not allowed when model is m"):
         resource._validate_contract(schema, {"model": "m", "source_task_id": "src_1"})
@@ -196,7 +189,7 @@ def test_validate_contract_runs_rules_before_field_requirements():
 
 def test_poll_recoerces_to_completed_class():
     resource = SampleResource(FakeHttp())
-    response = TaskResponse({"id": "1", "status": "completed", "images": [{"url": "u"}]})
+    response = TaskResponse({"id": "1", "status": "completed", "usage": {"cost": 0.05}, "images": [{"url": "u"}]})
     result = resource._poll_until_complete(lambda: response, PollingOptions(poll_interval=0, max_wait=1))
     assert isinstance(result, CompletedResponse)
     assert result.images[0].url == "u"
@@ -215,14 +208,12 @@ def test_run_hybrid_uses_opaque_location_and_decodes_completed_json(monkeypatch)
         ApiResponse(
             {
                 "id": "task_1",
-                "status": "completed",
+                "status": "completed", "usage": {"cost": 0.05},
                 "response": {
                     "status": 200,
                     "content_type": "application/json",
                     "headers": {"Location": "https://runapi.ai/result"},
-                    "body": {"id": "task_1", "status": "completed", "prompts": ["short prompt"]},
-                },
-            }
+                    "body": {"id": "task_1", "status": "completed", "usage": {"cost": 0.05}, "prompts": ["short prompt"]}}}
         ),
     )
 
@@ -234,8 +225,7 @@ def test_run_hybrid_uses_opaque_location_and_decodes_completed_json(monkeypatch)
     assert [call[:2] for call in http.calls] == [
         ("post", "/shorten"),
         ("get", "https://runapi.ai/api/v1/tasks/task_1"),
-        ("get", "https://runapi.ai/api/v1/tasks/task_1"),
-    ]
+        ("get", "https://runapi.ai/api/v1/tasks/task_1")]
     assert slept == [3.0, 2.0]
 
 
@@ -248,7 +238,7 @@ def test_run_hybrid_honors_http_date_retry_after(monkeypatch):
     http = FakeHttp(
         ApiResponse({"id": "task_1", "status": "processing"}, {"Location": "/api/v1/tasks/task_1", "Retry-After": initial_retry_after}, status_code=202),
         ApiResponse({"id": "task_1", "status": "processing"}, {"Retry-After": polling_retry_after}),
-        ApiResponse({"id": "task_1", "status": "completed", "response": {"status": 200, "content_type": "application/json", "headers": {}, "body": {"id": "task_1", "status": "completed", "prompts": ["short prompt"]}}}),
+        ApiResponse({"id": "task_1", "status": "completed", "usage": {"cost": 0.05}, "response": {"status": 200, "content_type": "application/json", "headers": {}, "body": {"id": "task_1", "status": "completed", "usage": {"cost": 0.05}, "prompts": ["short prompt"]}}}),
     )
 
     HybridResource(http)._run_hybrid("post", "/shorten", {"prompt": "long"})
@@ -273,14 +263,12 @@ def test_run_hybrid_follows_a_real_http_stub_and_reuses_generated_key(monkeypatc
             200,
             json={
                 "id": "task_1",
-                "status": "completed",
+                "status": "completed", "usage": {"cost": 0.05},
                 "response": {
                     "status": 200,
                     "content_type": "application/json",
                     "headers": {},
-                    "body": {"id": "task_1", "status": "completed", "prompts": ["short prompt"]},
-                },
-            },
+                    "body": {"id": "task_1", "status": "completed", "usage": {"cost": 0.05}, "prompts": ["short prompt"]}}},
         )
 
     http = HttpClient(
@@ -383,14 +371,12 @@ def test_subscribe_returns_text_srt_and_vtt_without_coercing_to_bytes(monkeypatc
         ApiResponse(
             {
                 "id": "task_text",
-                "status": "completed",
+                "status": "completed", "usage": {"cost": 0.05},
                 "response": {
                     "status": 200,
                     "content_type": "text/vtt; charset=utf-8",
                     "headers": {},
-                    "body": "WEBVTT\n\n00:00.000 --> 00:01.000\nHello",
-                },
-            }
+                    "body": "WEBVTT\n\n00:00.000 --> 00:01.000\nHello"}}
         )
     )
 
@@ -410,9 +396,7 @@ def test_subscribe_maps_failed_task_checkpoint_to_public_error(monkeypatch):
                     "status": 422,
                     "content_type": "application/json",
                     "headers": {},
-                    "body": {"error": "Prompt rejected"},
-                },
-            }
+                    "body": {"error": "Prompt rejected"}}}
         )
     )
 

runapi_core-0.8.3/src/runapi/core/version.py

@@ -1 +0,0 @@
-__version__ = "0.8.3"