feat: compute-forecast + scenario-aware models (F-1 regen)

robosystems_client/api/extensions_robo_ledger/compute_forecast.py

@@ -0,0 +1,314 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.compute_forecast_request import ComputeForecastRequest
+from ...models.error_response import ErrorResponse
+from ...models.operation_envelope_compute_forecast_response import (
+  OperationEnvelopeComputeForecastResponse,
+)
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+  graph_id: str,
+  *,
+  body: ComputeForecastRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> dict[str, Any]:
+  headers: dict[str, Any] = {}
+  if not isinstance(idempotency_key, Unset):
+    headers["Idempotency-Key"] = idempotency_key
+
+  _kwargs: dict[str, Any] = {
+    "method": "post",
+    "url": "/extensions/roboledger/{graph_id}/operations/compute-forecast".format(
+      graph_id=quote(str(graph_id), safe=""),
+    ),
+  }
+
+  _kwargs["json"] = body.to_dict()
+
+  headers["Content-Type"] = "application/json"
+
+  _kwargs["headers"] = headers
+  return _kwargs
+
+
+def _parse_response(
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | OperationEnvelopeComputeForecastResponse | None:
+  if response.status_code == 200:
+    response_200 = OperationEnvelopeComputeForecastResponse.from_dict(response.json())
+
+    return response_200
+
+  if response.status_code == 400:
+    response_400 = ErrorResponse.from_dict(response.json())
+
+    return response_400
+
+  if response.status_code == 401:
+    response_401 = ErrorResponse.from_dict(response.json())
+
+    return response_401
+
+  if response.status_code == 403:
+    response_403 = ErrorResponse.from_dict(response.json())
+
+    return response_403
+
+  if response.status_code == 404:
+    response_404 = ErrorResponse.from_dict(response.json())
+
+    return response_404
+
+  if response.status_code == 409:
+    response_409 = ErrorResponse.from_dict(response.json())
+
+    return response_409
+
+  if response.status_code == 422:
+    response_422 = ErrorResponse.from_dict(response.json())
+
+    return response_422
+
+  if response.status_code == 429:
+    response_429 = ErrorResponse.from_dict(response.json())
+
+    return response_429
+
+  if response.status_code == 500:
+    response_500 = ErrorResponse.from_dict(response.json())
+
+    return response_500
+
+  if client.raise_on_unexpected_status:
+    raise errors.UnexpectedStatus(response.status_code, response.content)
+  else:
+    return None
+
+
+def _build_response(
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ErrorResponse | OperationEnvelopeComputeForecastResponse]:
+  return Response(
+    status_code=HTTPStatus(response.status_code),
+    content=response.content,
+    headers=response.headers,
+    parsed=_parse_response(client=client, response=response),
+  )
+
+
+def sync_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: ComputeForecastRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> Response[ErrorResponse | OperationEnvelopeComputeForecastResponse]:
+  """Compute Forecast for a Forecast Block
+
+   Walks a forecast block's driver cascade month-by-month forward from its base period: lever-driven
+  rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines,
+  calc-DAG subtotals — upserting one scenario income-statement FactSet (plus a working-capital
+  balance-sheet set) per forward month, all keyed by the block's scenario_id (NULL = actuals; scenario
+  reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months
+  or unbound operands are skipped with a reason (their targets fall back to carry-forward), never
+  errored. Deterministic and non-AI — no credits consumed.
+
+  **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
+  return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+
+  Args:
+      graph_id (str):
+      idempotency_key (None | str | Unset):
+      body (ComputeForecastRequest): Request body for the ``compute-forecast`` operation.
+
+          Walks the scenario's driver cascade month-by-month forward from the
+          forecast block's ``base_period``: lever-driven Derive rules in
+          dependency order, carry-forward for unmodeled IS lines, calc-DAG
+          subtotals — upserting one scenario IS FactSet (+ a working-capital BS
+          set) per forward month, all keyed by the forecast block's
+          ``scenario_id``. Re-running replaces each month's values (the
+          compute-metrics drift semantics). Deterministic and non-AI — no
+          credits consumed.
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      Response[ErrorResponse | OperationEnvelopeComputeForecastResponse]
+  """
+
+  kwargs = _get_kwargs(
+    graph_id=graph_id,
+    body=body,
+    idempotency_key=idempotency_key,
+  )
+
+  response = client.get_httpx_client().request(
+    **kwargs,
+  )
+
+  return _build_response(client=client, response=response)
+
+
+def sync(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: ComputeForecastRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> ErrorResponse | OperationEnvelopeComputeForecastResponse | None:
+  """Compute Forecast for a Forecast Block
+
+   Walks a forecast block's driver cascade month-by-month forward from its base period: lever-driven
+  rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines,
+  calc-DAG subtotals — upserting one scenario income-statement FactSet (plus a working-capital
+  balance-sheet set) per forward month, all keyed by the block's scenario_id (NULL = actuals; scenario
+  reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months
+  or unbound operands are skipped with a reason (their targets fall back to carry-forward), never
+  errored. Deterministic and non-AI — no credits consumed.
+
+  **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
+  return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+
+  Args:
+      graph_id (str):
+      idempotency_key (None | str | Unset):
+      body (ComputeForecastRequest): Request body for the ``compute-forecast`` operation.
+
+          Walks the scenario's driver cascade month-by-month forward from the
+          forecast block's ``base_period``: lever-driven Derive rules in
+          dependency order, carry-forward for unmodeled IS lines, calc-DAG
+          subtotals — upserting one scenario IS FactSet (+ a working-capital BS
+          set) per forward month, all keyed by the forecast block's
+          ``scenario_id``. Re-running replaces each month's values (the
+          compute-metrics drift semantics). Deterministic and non-AI — no
+          credits consumed.
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      ErrorResponse | OperationEnvelopeComputeForecastResponse
+  """
+
+  return sync_detailed(
+    graph_id=graph_id,
+    client=client,
+    body=body,
+    idempotency_key=idempotency_key,
+  ).parsed
+
+
+async def asyncio_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: ComputeForecastRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> Response[ErrorResponse | OperationEnvelopeComputeForecastResponse]:
+  """Compute Forecast for a Forecast Block
+
+   Walks a forecast block's driver cascade month-by-month forward from its base period: lever-driven
+  rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines,
+  calc-DAG subtotals — upserting one scenario income-statement FactSet (plus a working-capital
+  balance-sheet set) per forward month, all keyed by the block's scenario_id (NULL = actuals; scenario
+  reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months
+  or unbound operands are skipped with a reason (their targets fall back to carry-forward), never
+  errored. Deterministic and non-AI — no credits consumed.
+
+  **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
+  return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+
+  Args:
+      graph_id (str):
+      idempotency_key (None | str | Unset):
+      body (ComputeForecastRequest): Request body for the ``compute-forecast`` operation.
+
+          Walks the scenario's driver cascade month-by-month forward from the
+          forecast block's ``base_period``: lever-driven Derive rules in
+          dependency order, carry-forward for unmodeled IS lines, calc-DAG
+          subtotals — upserting one scenario IS FactSet (+ a working-capital BS
+          set) per forward month, all keyed by the forecast block's
+          ``scenario_id``. Re-running replaces each month's values (the
+          compute-metrics drift semantics). Deterministic and non-AI — no
+          credits consumed.
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      Response[ErrorResponse | OperationEnvelopeComputeForecastResponse]
+  """
+
+  kwargs = _get_kwargs(
+    graph_id=graph_id,
+    body=body,
+    idempotency_key=idempotency_key,
+  )
+
+  response = await client.get_async_httpx_client().request(**kwargs)
+
+  return _build_response(client=client, response=response)
+
+
+async def asyncio(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: ComputeForecastRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> ErrorResponse | OperationEnvelopeComputeForecastResponse | None:
+  """Compute Forecast for a Forecast Block
+
+   Walks a forecast block's driver cascade month-by-month forward from its base period: lever-driven
+  rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines,
+  calc-DAG subtotals — upserting one scenario income-statement FactSet (plus a working-capital
+  balance-sheet set) per forward month, all keyed by the block's scenario_id (NULL = actuals; scenario
+  reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months
+  or unbound operands are skipped with a reason (their targets fall back to carry-forward), never
+  errored. Deterministic and non-AI — no credits consumed.
+
+  **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
+  return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+
+  Args:
+      graph_id (str):
+      idempotency_key (None | str | Unset):
+      body (ComputeForecastRequest): Request body for the ``compute-forecast`` operation.
+
+          Walks the scenario's driver cascade month-by-month forward from the
+          forecast block's ``base_period``: lever-driven Derive rules in
+          dependency order, carry-forward for unmodeled IS lines, calc-DAG
+          subtotals — upserting one scenario IS FactSet (+ a working-capital BS
+          set) per forward month, all keyed by the forecast block's
+          ``scenario_id``. Re-running replaces each month's values (the
+          compute-metrics drift semantics). Deterministic and non-AI — no
+          credits consumed.
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      ErrorResponse | OperationEnvelopeComputeForecastResponse
+  """
+
+  return (
+    await asyncio_detailed(
+      graph_id=graph_id,
+      client=client,
+      body=body,
+      idempotency_key=idempotency_key,
+    )
+  ).parsed