docket-client 0.3.2__py3-none-any.whl

docket/api/recurring_acquisitions/list_recurring_acquisitions.py

@@ -0,0 +1,248 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.recurring_acquisition_response import RecurringAcquisitionResponse
+from ...types import UNSET, Unset
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    subject_id: str | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    include_archived: bool | None | Unset = UNSET,
+    include_superseded: bool | None | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["subject_id"] = subject_id
+
+    params["instrument_id"] = instrument_id
+
+    json_include_archived: bool | None | Unset
+    if isinstance(include_archived, Unset):
+        json_include_archived = UNSET
+    else:
+        json_include_archived = include_archived
+    params["include_archived"] = json_include_archived
+
+    json_include_superseded: bool | None | Unset
+    if isinstance(include_superseded, Unset):
+        json_include_superseded = UNSET
+    else:
+        json_include_superseded = include_superseded
+    params["include_superseded"] = json_include_superseded
+
+    json_limit: int | None | Unset
+    if isinstance(limit, Unset):
+        json_limit = UNSET
+    else:
+        json_limit = limit
+    params["limit"] = json_limit
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/recurring-acquisitions",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> list[RecurringAcquisitionResponse] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = RecurringAcquisitionResponse.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
+
+    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[list[RecurringAcquisitionResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    include_archived: bool | None | Unset = UNSET,
+    include_superseded: bool | None | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> Response[list[RecurringAcquisitionResponse]]:
+    """Recurring definitions, newest first. Definitions replaced by a split are left out unless
+    include_superseded=true.
+
+    Args:
+        subject_id (str | Unset):
+        instrument_id (str | Unset):
+        include_archived (bool | None | Unset):
+        include_superseded (bool | None | Unset):
+        limit (int | None | Unset):
+
+    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[list[RecurringAcquisitionResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        subject_id=subject_id,
+        instrument_id=instrument_id,
+        include_archived=include_archived,
+        include_superseded=include_superseded,
+        limit=limit,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    include_archived: bool | None | Unset = UNSET,
+    include_superseded: bool | None | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> list[RecurringAcquisitionResponse] | None:
+    """Recurring definitions, newest first. Definitions replaced by a split are left out unless
+    include_superseded=true.
+
+    Args:
+        subject_id (str | Unset):
+        instrument_id (str | Unset):
+        include_archived (bool | None | Unset):
+        include_superseded (bool | None | Unset):
+        limit (int | None | Unset):
+
+    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:
+        list[RecurringAcquisitionResponse]
+    """
+
+    return sync_detailed(
+        client=client,
+        subject_id=subject_id,
+        instrument_id=instrument_id,
+        include_archived=include_archived,
+        include_superseded=include_superseded,
+        limit=limit,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    include_archived: bool | None | Unset = UNSET,
+    include_superseded: bool | None | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> Response[list[RecurringAcquisitionResponse]]:
+    """Recurring definitions, newest first. Definitions replaced by a split are left out unless
+    include_superseded=true.
+
+    Args:
+        subject_id (str | Unset):
+        instrument_id (str | Unset):
+        include_archived (bool | None | Unset):
+        include_superseded (bool | None | Unset):
+        limit (int | None | Unset):
+
+    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[list[RecurringAcquisitionResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        subject_id=subject_id,
+        instrument_id=instrument_id,
+        include_archived=include_archived,
+        include_superseded=include_superseded,
+        limit=limit,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    include_archived: bool | None | Unset = UNSET,
+    include_superseded: bool | None | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> list[RecurringAcquisitionResponse] | None:
+    """Recurring definitions, newest first. Definitions replaced by a split are left out unless
+    include_superseded=true.
+
+    Args:
+        subject_id (str | Unset):
+        instrument_id (str | Unset):
+        include_archived (bool | None | Unset):
+        include_superseded (bool | None | Unset):
+        limit (int | None | Unset):
+
+    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:
+        list[RecurringAcquisitionResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            subject_id=subject_id,
+            instrument_id=instrument_id,
+            include_archived=include_archived,
+            include_superseded=include_superseded,
+            limit=limit,
+        )
+    ).parsed

docket/api/recurring_acquisitions/preview_recurring_acquisition.py

@@ -0,0 +1,187 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.create_recurring_acquisition_request import CreateRecurringAcquisitionRequest
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...models.problem_details import ProblemDetails
+from ...models.recurrence_preview_response import RecurrencePreviewResponse
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    body: CreateRecurringAcquisitionRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/recurring-acquisitions/preview",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse | None:
+    if response.status_code == 200:
+        response_200 = RecurrencePreviewResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HttpValidationProblemDetails.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 503:
+        response_503 = ProblemDetails.from_dict(response.json())
+
+        return response_503
+
+    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[HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: CreateRecurringAcquisitionRequest,
+) -> Response[HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse]:
+    """What creating this series would schedule: occurrences, DST-skipped dates and per-occurrence overlap
+    warnings. Writes nothing.
+
+    Args:
+        body (CreateRecurringAcquisitionRequest): Plan a finite series. The acquisition fields
+            mean what they do on
+            CreateScheduledAcquisitionRequest and are copied onto every occurrence.
+
+    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[HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: CreateRecurringAcquisitionRequest,
+) -> HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse | None:
+    """What creating this series would schedule: occurrences, DST-skipped dates and per-occurrence overlap
+    warnings. Writes nothing.
+
+    Args:
+        body (CreateRecurringAcquisitionRequest): Plan a finite series. The acquisition fields
+            mean what they do on
+            CreateScheduledAcquisitionRequest and are copied onto every occurrence.
+
+    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:
+        HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: CreateRecurringAcquisitionRequest,
+) -> Response[HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse]:
+    """What creating this series would schedule: occurrences, DST-skipped dates and per-occurrence overlap
+    warnings. Writes nothing.
+
+    Args:
+        body (CreateRecurringAcquisitionRequest): Plan a finite series. The acquisition fields
+            mean what they do on
+            CreateScheduledAcquisitionRequest and are copied onto every occurrence.
+
+    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[HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: CreateRecurringAcquisitionRequest,
+) -> HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse | None:
+    """What creating this series would schedule: occurrences, DST-skipped dates and per-occurrence overlap
+    warnings. Writes nothing.
+
+    Args:
+        body (CreateRecurringAcquisitionRequest): Plan a finite series. The acquisition fields
+            mean what they do on
+            CreateScheduledAcquisitionRequest and are copied onto every occurrence.
+
+    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:
+        HttpValidationProblemDetails | ProblemDetails | RecurrencePreviewResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

docket/api/recurring_acquisitions/preview_split_recurring_acquisition.py

@@ -0,0 +1,232 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...models.problem_details import ProblemDetails
+from ...models.split_preview_response import SplitPreviewResponse
+from ...models.split_recurring_acquisition_request import SplitRecurringAcquisitionRequest
+from typing import cast
+
+
+def _get_kwargs(
+    id: int,
+    *,
+    body: SplitRecurringAcquisitionRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/recurring-acquisitions/{id}/split/preview".format(
+            id=quote(str(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
+) -> HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse | None:
+    if response.status_code == 200:
+        response_200 = SplitPreviewResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = ProblemDetails.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 409:
+        response_409 = ProblemDetails.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 422:
+        response_422 = HttpValidationProblemDetails.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 503:
+        response_503 = ProblemDetails.from_dict(response.json())
+
+        return response_503
+
+    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[HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    body: SplitRecurringAcquisitionRequest,
+) -> Response[HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse]:
+    """What splitting this series from effective_date would do: new occurrences, skipped dates, overlap
+    warnings, the old occurrences that would be archived (replaced) and those that stay (kept). Writes
+    nothing.
+
+    Args:
+        id (int):
+        body (SplitRecurringAcquisitionRequest): Edit a series from a date onward: end the old
+            series the day before
+            `effective_date` and start a new one from it. Carries the complete new definition (the
+            same fields as
+            CreateRecurringAcquisitionRequest), not a patch; clients prefill it from the old one.
+            `rule.start_date` must equal `effective_date`. For a `count` rule, `count` is the number
+            of occurrences of the new part.
+
+    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[HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    body: SplitRecurringAcquisitionRequest,
+) -> HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse | None:
+    """What splitting this series from effective_date would do: new occurrences, skipped dates, overlap
+    warnings, the old occurrences that would be archived (replaced) and those that stay (kept). Writes
+    nothing.
+
+    Args:
+        id (int):
+        body (SplitRecurringAcquisitionRequest): Edit a series from a date onward: end the old
+            series the day before
+            `effective_date` and start a new one from it. Carries the complete new definition (the
+            same fields as
+            CreateRecurringAcquisitionRequest), not a patch; clients prefill it from the old one.
+            `rule.start_date` must equal `effective_date`. For a `count` rule, `count` is the number
+            of occurrences of the new part.
+
+    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:
+        HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    body: SplitRecurringAcquisitionRequest,
+) -> Response[HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse]:
+    """What splitting this series from effective_date would do: new occurrences, skipped dates, overlap
+    warnings, the old occurrences that would be archived (replaced) and those that stay (kept). Writes
+    nothing.
+
+    Args:
+        id (int):
+        body (SplitRecurringAcquisitionRequest): Edit a series from a date onward: end the old
+            series the day before
+            `effective_date` and start a new one from it. Carries the complete new definition (the
+            same fields as
+            CreateRecurringAcquisitionRequest), not a patch; clients prefill it from the old one.
+            `rule.start_date` must equal `effective_date`. For a `count` rule, `count` is the number
+            of occurrences of the new part.
+
+    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[HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    body: SplitRecurringAcquisitionRequest,
+) -> HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse | None:
+    """What splitting this series from effective_date would do: new occurrences, skipped dates, overlap
+    warnings, the old occurrences that would be archived (replaced) and those that stay (kept). Writes
+    nothing.
+
+    Args:
+        id (int):
+        body (SplitRecurringAcquisitionRequest): Edit a series from a date onward: end the old
+            series the day before
+            `effective_date` and start a new one from it. Carries the complete new definition (the
+            same fields as
+            CreateRecurringAcquisitionRequest), not a patch; clients prefill it from the old one.
+            `rule.start_date` must equal `effective_date`. For a `count` rule, `count` is the number
+            of occurrences of the new part.
+
+    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:
+        HttpValidationProblemDetails | ProblemDetails | SplitPreviewResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+        )
+    ).parsed