Repository navigation
EN Reference SDK Types
English · Türkçe · Languages / Diller
Scope: JSON API Forge 0.5.1 · Source review: 17 September 2026 · Language: English
Signatures are extracted from source Python AST and are reference declarations, not a runnable program. Do not pass self explicitly when calling an instance. Arguments after * are keyword-only. Await async def methods. Dataclass fields also describe constructor parameters.
Errors/retries, DDM/YoungLion.
Source module: json_api_forge/models.py
| Field | Type | Default |
|---|---|---|
data |
T |
Required |
status_code |
int |
Required |
request_id |
str | None |
Required |
idempotent_replay |
bool |
False |
cache_status |
str | None |
None |
| Field | Type | Default |
|---|---|---|
method |
str |
Required |
path |
str |
Required |
attempt |
int |
Required |
elapsed_seconds |
float |
Required |
status_code |
int | None |
Required |
request_id |
str | None |
Required |
error |
str | None |
Required |
Source module: json_api_forge/errors.py
Inherits behavior from its base class; see the source and error guide.
Inherits behavior from its base class; see the source and error guide.
Inherits behavior from its base class; see the source and error guide.
Inherits behavior from its base class; see the source and error guide.
Inherits behavior from its base class; see the source and error guide.
Inherits behavior from its base class; see the source and error guide.
| Field | Type | Default |
|---|---|---|
status_code |
int |
Required |
detail |
Any |
Required |
request_id |
str | None |
None |
retry_after |
str | None |
None |
Source module: json_api_forge/options.py
| Field | Type | Default |
|---|---|---|
max_attempts |
int |
3 |
backoff_seconds |
float |
0.2 |
max_backoff_seconds |
float |
2.0 |
multiplier |
float |
2.0 |
jitter_ratio |
float |
0.15 |
retry_statuses |
frozenset[int] |
field(default_factory=lambda: frozenset({408, 425, 429, 502, 503, 504})) |
def permits(self, method: str, *, idempotency_key: str | None) -> bool: ...def delay(self, failed_attempt: int, *, retry_after: str | None=None) -> float: ...Source module: json_api_forge/integrations/ddm.py
def __init__(self, client: ForgeClient): ...def request(self, method: str, path: str, **kwargs: Any) -> ForgeResponse[Any]: ...def call_operation(self, project: str, operation: str, payload: Any, *, idempotency_key: str | None=None): ...def close(self) -> None: ...def __enter__(self) -> DDMForgeClient: ...def __exit__(self, *_args: Any) -> None: ...def __init__(self, client: AsyncForgeClient): ...async def request(self, method: str, path: str, **kwargs: Any) -> ForgeResponse[Any]: ...async def call_operation(self, project: str, operation: str, payload: Any, *, idempotency_key: str | None=None): ...async def aclose(self) -> None: ...async def __aenter__(self) -> AsyncDDMForgeClient: ...async def __aexit__(self, *_args: Any) -> None: ...Source module: json_api_forge/integrations/younglion.py
def create_item(self, project: str, resource: str, payload: Any, *, idempotency_key: str | None=None): ...def update_item(self, project: str, resource: str, item_id: str, payload: Any): ...def list_items(self, project: str, resource: str, *, params: Mapping[str, Any] | None=None): ...@classmethod
def connect(cls, base_url: str, **kwargs: Any) -> YoungLionForgeClient: ...def close(self) -> None: ...def __enter__(self) -> YoungLionForgeClient: ...def __exit__(self, *_args: Any) -> None: ...This page describes the behavior at the pinned commits below. Recheck these contracts when upgrading.
python-library/json_api_forge/models.pypython-library/json_api_forge/errors.pypython-library/json_api_forge/options.pypython-library/json_api_forge/integrations/ddm.pypython-library/json_api_forge/integrations/younglion.py