feat(ledger): list_elements include_inactive, and the schedule surface from #1922

robosystems_client/api/robo_ledger_fiscal_close/preview_schedule.py

@@ -0,0 +1,294 @@
+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.error_response import ErrorResponse
+from ...models.operation_envelope_preview_schedule_response import (
+  OperationEnvelopePreviewScheduleResponse,
+)
+from ...models.preview_schedule_request import PreviewScheduleRequest
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+  graph_id: str,
+  *,
+  body: PreviewScheduleRequest,
+  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/preview-schedule".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 | OperationEnvelopePreviewScheduleResponse | None:
+  if response.status_code == 200:
+    response_200 = OperationEnvelopePreviewScheduleResponse.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 | OperationEnvelopePreviewScheduleResponse]:
+  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: PreviewScheduleRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> Response[ErrorResponse | OperationEnvelopePreviewScheduleResponse]:
+  """Preview Schedule
+
+   Generate a schedule from a definition without keeping it: the same generator and guards as creating
+  one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope
+  create would leave (its ids provisional) and the period-by-period roll-forward: the balance the
+  schedule carries on the account it credits (a loan's: the note), opening, the period's amount,
+  closing, and for a loan the interest, payment, principal and current portion. Show it to the person
+  before asking to create. A definition create would refuse (a roll-forward that climbs where it
+  should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
+  any active schedule already posting the same accounts in the same months. With
+  `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
+  month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
+  nothing has posted, `terminate_and_succeed` after.
+
+  **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 (PreviewScheduleRequest): A schedule's definition, generated without being kept.
+
+  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 | OperationEnvelopePreviewScheduleResponse]
+  """
+
+  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: PreviewScheduleRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> ErrorResponse | OperationEnvelopePreviewScheduleResponse | None:
+  """Preview Schedule
+
+   Generate a schedule from a definition without keeping it: the same generator and guards as creating
+  one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope
+  create would leave (its ids provisional) and the period-by-period roll-forward: the balance the
+  schedule carries on the account it credits (a loan's: the note), opening, the period's amount,
+  closing, and for a loan the interest, payment, principal and current portion. Show it to the person
+  before asking to create. A definition create would refuse (a roll-forward that climbs where it
+  should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
+  any active schedule already posting the same accounts in the same months. With
+  `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
+  month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
+  nothing has posted, `terminate_and_succeed` after.
+
+  **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 (PreviewScheduleRequest): A schedule's definition, generated without being kept.
+
+  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 | OperationEnvelopePreviewScheduleResponse
+  """
+
+  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: PreviewScheduleRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> Response[ErrorResponse | OperationEnvelopePreviewScheduleResponse]:
+  """Preview Schedule
+
+   Generate a schedule from a definition without keeping it: the same generator and guards as creating
+  one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope
+  create would leave (its ids provisional) and the period-by-period roll-forward: the balance the
+  schedule carries on the account it credits (a loan's: the note), opening, the period's amount,
+  closing, and for a loan the interest, payment, principal and current portion. Show it to the person
+  before asking to create. A definition create would refuse (a roll-forward that climbs where it
+  should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
+  any active schedule already posting the same accounts in the same months. With
+  `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
+  month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
+  nothing has posted, `terminate_and_succeed` after.
+
+  **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 (PreviewScheduleRequest): A schedule's definition, generated without being kept.
+
+  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 | OperationEnvelopePreviewScheduleResponse]
+  """
+
+  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: PreviewScheduleRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> ErrorResponse | OperationEnvelopePreviewScheduleResponse | None:
+  """Preview Schedule
+
+   Generate a schedule from a definition without keeping it: the same generator and guards as creating
+  one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope
+  create would leave (its ids provisional) and the period-by-period roll-forward: the balance the
+  schedule carries on the account it credits (a loan's: the note), opening, the period's amount,
+  closing, and for a loan the interest, payment, principal and current portion. Show it to the person
+  before asking to create. A definition create would refuse (a roll-forward that climbs where it
+  should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
+  any active schedule already posting the same accounts in the same months. With
+  `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
+  month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
+  nothing has posted, `terminate_and_succeed` after.
+
+  **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 (PreviewScheduleRequest): A schedule's definition, generated without being kept.
+
+  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 | OperationEnvelopePreviewScheduleResponse
+  """
+
+  return (
+    await asyncio_detailed(
+      graph_id=graph_id,
+      client=client,
+      body=body,
+      idempotency_key=idempotency_key,
+    )
+  ).parsed