feat: add reconciliations to the ledger facade

robosystems_client/api/robo_ledger_ledger_events/preview_reconciliations.py

@@ -0,0 +1,300 @@
+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_reconciliation_preview_response import (
+  OperationEnvelopeReconciliationPreviewResponse,
+)
+from ...models.preview_reconciliations_request import PreviewReconciliationsRequest
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+  graph_id: str,
+  *,
+  body: PreviewReconciliationsRequest,
+  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-reconciliations".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 | OperationEnvelopeReconciliationPreviewResponse | None:
+  if response.status_code == 200:
+    response_200 = OperationEnvelopeReconciliationPreviewResponse.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 | OperationEnvelopeReconciliationPreviewResponse]:
+  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: PreviewReconciliationsRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> Response[ErrorResponse | OperationEnvelopeReconciliationPreviewResponse]:
+  """Preview Reconciliations
+
+   Compare the ledger at a period end with something outside it, without recording anything. `method`
+  picks the check. `source_ledger` (the default) reads QuickBooks' own trial balance for the period
+  end and sets it beside the ledger's, account by account: balance-sheet accounts cumulatively, income
+  and expense accounts from the start of the fiscal year. A difference there means the ledger's copy
+  of the books has drifted from the source (a transaction deleted or back-dated there after it was
+  synced, or activity not yet synced), so run it before trusting any other figure on a synced ledger;
+  it needs a connected QuickBooks ledger. `schedule_register` compares each asset account a schedule
+  carries a balance on (a prepaid, accumulated depreciation, a fixed-asset cost account) with what its
+  schedules say it holds, and lists the schedules behind each figure. A difference there is a balance
+  with no schedule behind it, or a scheduled amount the ledger does not hold. Each row carries both
+  balances, the difference, and whether the account ties.
+
+  **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 (PreviewReconciliationsRequest): Compare the ledger's balances at a period end with
+          an independent source.
+
+  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 | OperationEnvelopeReconciliationPreviewResponse]
+  """
+
+  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: PreviewReconciliationsRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> ErrorResponse | OperationEnvelopeReconciliationPreviewResponse | None:
+  """Preview Reconciliations
+
+   Compare the ledger at a period end with something outside it, without recording anything. `method`
+  picks the check. `source_ledger` (the default) reads QuickBooks' own trial balance for the period
+  end and sets it beside the ledger's, account by account: balance-sheet accounts cumulatively, income
+  and expense accounts from the start of the fiscal year. A difference there means the ledger's copy
+  of the books has drifted from the source (a transaction deleted or back-dated there after it was
+  synced, or activity not yet synced), so run it before trusting any other figure on a synced ledger;
+  it needs a connected QuickBooks ledger. `schedule_register` compares each asset account a schedule
+  carries a balance on (a prepaid, accumulated depreciation, a fixed-asset cost account) with what its
+  schedules say it holds, and lists the schedules behind each figure. A difference there is a balance
+  with no schedule behind it, or a scheduled amount the ledger does not hold. Each row carries both
+  balances, the difference, and whether the account ties.
+
+  **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 (PreviewReconciliationsRequest): Compare the ledger's balances at a period end with
+          an independent source.
+
+  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 | OperationEnvelopeReconciliationPreviewResponse
+  """
+
+  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: PreviewReconciliationsRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> Response[ErrorResponse | OperationEnvelopeReconciliationPreviewResponse]:
+  """Preview Reconciliations
+
+   Compare the ledger at a period end with something outside it, without recording anything. `method`
+  picks the check. `source_ledger` (the default) reads QuickBooks' own trial balance for the period
+  end and sets it beside the ledger's, account by account: balance-sheet accounts cumulatively, income
+  and expense accounts from the start of the fiscal year. A difference there means the ledger's copy
+  of the books has drifted from the source (a transaction deleted or back-dated there after it was
+  synced, or activity not yet synced), so run it before trusting any other figure on a synced ledger;
+  it needs a connected QuickBooks ledger. `schedule_register` compares each asset account a schedule
+  carries a balance on (a prepaid, accumulated depreciation, a fixed-asset cost account) with what its
+  schedules say it holds, and lists the schedules behind each figure. A difference there is a balance
+  with no schedule behind it, or a scheduled amount the ledger does not hold. Each row carries both
+  balances, the difference, and whether the account ties.
+
+  **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 (PreviewReconciliationsRequest): Compare the ledger's balances at a period end with
+          an independent source.
+
+  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 | OperationEnvelopeReconciliationPreviewResponse]
+  """
+
+  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: PreviewReconciliationsRequest,
+  idempotency_key: None | str | Unset = UNSET,
+) -> ErrorResponse | OperationEnvelopeReconciliationPreviewResponse | None:
+  """Preview Reconciliations
+
+   Compare the ledger at a period end with something outside it, without recording anything. `method`
+  picks the check. `source_ledger` (the default) reads QuickBooks' own trial balance for the period
+  end and sets it beside the ledger's, account by account: balance-sheet accounts cumulatively, income
+  and expense accounts from the start of the fiscal year. A difference there means the ledger's copy
+  of the books has drifted from the source (a transaction deleted or back-dated there after it was
+  synced, or activity not yet synced), so run it before trusting any other figure on a synced ledger;
+  it needs a connected QuickBooks ledger. `schedule_register` compares each asset account a schedule
+  carries a balance on (a prepaid, accumulated depreciation, a fixed-asset cost account) with what its
+  schedules say it holds, and lists the schedules behind each figure. A difference there is a balance
+  with no schedule behind it, or a scheduled amount the ledger does not hold. Each row carries both
+  balances, the difference, and whether the account ties.
+
+  **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 (PreviewReconciliationsRequest): Compare the ledger's balances at a period end with
+          an independent source.
+
+  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 | OperationEnvelopeReconciliationPreviewResponse
+  """
+
+  return (
+    await asyncio_detailed(
+      graph_id=graph_id,
+      client=client,
+      body=body,
+      idempotency_key=idempotency_key,
+    )
+  ).parsed