hubble-sdk-python 0.0.3__py3-none-any.whl → 0.2.0__py3-none-any.whl

hubble_sdk/__init__.py

@@ -28,6 +28,13 @@ from ._hubble import (
     PdfExport,
     TokenSet,
 )
+from ._webhooks import (
+    WEBHOOK_SIGNATURE_HEADER,
+    WebhookEvent,
+    WebhookEventSource,
+    WebhookSignatureError,
+    construct_webhook_event,
+)
 
 __all__ = [
     "Hubble",
@@ -36,6 +43,11 @@ __all__ = [
     "ConsentTimeout",
     "TokenSet",
     "PdfExport",
+    "construct_webhook_event",
+    "WebhookEvent",
+    "WebhookEventSource",
+    "WebhookSignatureError",
+    "WEBHOOK_SIGNATURE_HEADER",
     "Consent",
     "ConsentStatus",
     "DeviceAuthorizationResponse",

hubble_sdk/_generated/api/default/attach_client_authorization.py

@@ -8,9 +8,7 @@ from ... import errors
 from ...client import AuthenticatedClient, Client
 from ...models.api_error import ApiError
 from ...models.attach_client_authorization_body import AttachClientAuthorizationBody
-from ...models.attach_client_authorization_response_201 import (
-    AttachClientAuthorizationResponse201,
-)
+from ...models.consent import Consent
 from ...types import Response
 
 
@@ -38,11 +36,11 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> ApiError | AttachClientAuthorizationResponse201 | None:
-    if response.status_code == 201:
-        response_201 = AttachClientAuthorizationResponse201.from_dict(response.json())
+) -> ApiError | Consent | None:
+    if response.status_code == 200:
+        response_200 = Consent.from_dict(response.json())
 
-        return response_201
+        return response_200
 
     if response.status_code == 400:
         response_400 = ApiError.from_dict(response.json())
@@ -64,6 +62,11 @@ def _parse_response(
 
         return response_404
 
+    if response.status_code == 409:
+        response_409 = ApiError.from_dict(response.json())
+
+        return response_409
+
     if response.status_code == 413:
         response_413 = ApiError.from_dict(response.json())
 
@@ -77,7 +80,7 @@ def _parse_response(
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[ApiError | AttachClientAuthorizationResponse201]:
+) -> Response[ApiError | Consent]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -91,7 +94,7 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
     body: AttachClientAuthorizationBody,
-) -> Response[ApiError | AttachClientAuthorizationResponse201]:
+) -> Response[ApiError | Consent]:
     """Attach a customer-supplied HIPAA authorization
 
      Upload an already-signed HIPAA authorization for a consent and grant delegated retrieval from the
@@ -107,7 +110,7 @@ def sync_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[ApiError | AttachClientAuthorizationResponse201]
+        Response[ApiError | Consent]
     """
 
     kwargs = _get_kwargs(
@@ -127,7 +130,7 @@ def sync(
     *,
     client: AuthenticatedClient,
     body: AttachClientAuthorizationBody,
-) -> ApiError | AttachClientAuthorizationResponse201 | None:
+) -> ApiError | Consent | None:
     """Attach a customer-supplied HIPAA authorization
 
      Upload an already-signed HIPAA authorization for a consent and grant delegated retrieval from the
@@ -143,7 +146,7 @@ def sync(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        ApiError | AttachClientAuthorizationResponse201
+        ApiError | Consent
     """
 
     return sync_detailed(
@@ -158,7 +161,7 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
     body: AttachClientAuthorizationBody,
-) -> Response[ApiError | AttachClientAuthorizationResponse201]:
+) -> Response[ApiError | Consent]:
     """Attach a customer-supplied HIPAA authorization
 
      Upload an already-signed HIPAA authorization for a consent and grant delegated retrieval from the
@@ -174,7 +177,7 @@ async def asyncio_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[ApiError | AttachClientAuthorizationResponse201]
+        Response[ApiError | Consent]
     """
 
     kwargs = _get_kwargs(
@@ -192,7 +195,7 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
     body: AttachClientAuthorizationBody,
-) -> ApiError | AttachClientAuthorizationResponse201 | None:
+) -> ApiError | Consent | None:
     """Attach a customer-supplied HIPAA authorization
 
      Upload an already-signed HIPAA authorization for a consent and grant delegated retrieval from the
@@ -208,7 +211,7 @@ async def asyncio(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        ApiError | AttachClientAuthorizationResponse201
+        ApiError | Consent
     """
 
     return (

hubble_sdk/_generated/api/default/export_patient_fhir.py

@@ -0,0 +1,262 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.export_patient_fhir_prefer import ExportPatientFhirPrefer
+from ...models.export_patient_fhir_response_202 import ExportPatientFhirResponse202
+from ...models.fhir_resource import FhirResource
+from ...models.operation_outcome import OperationOutcome
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    field_count: int | Unset = UNSET,
+    field_offset: int | Unset = UNSET,
+    prefer: ExportPatientFhirPrefer | Unset = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(prefer, Unset):
+        headers["Prefer"] = str(prefer)
+
+    params: dict[str, Any] = {}
+
+    params["_count"] = field_count
+
+    params["_offset"] = field_offset
+
+    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/fhir/Patient/$everything",
+        "params": params,
+    }
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ExportPatientFhirResponse202 | FhirResource | OperationOutcome | None:
+    if response.status_code == 200:
+        response_200 = FhirResource.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 202:
+        response_202 = ExportPatientFhirResponse202.from_dict(response.json())
+
+        return response_202
+
+    if response.status_code == 400:
+        response_400 = OperationOutcome.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = OperationOutcome.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = OperationOutcome.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = OperationOutcome.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = OperationOutcome.from_dict(response.json())
+
+        return response_429
+
+    if response.status_code == 503:
+        response_503 = OperationOutcome.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[ExportPatientFhirResponse202 | FhirResource | OperationOutcome]:
+    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,
+    field_count: int | Unset = UNSET,
+    field_offset: int | Unset = UNSET,
+    prefer: ExportPatientFhirPrefer | Unset = UNSET,
+) -> Response[ExportPatientFhirResponse202 | FhirResource | OperationOutcome]:
+    """Read or asynchronously export the patient's FHIR record
+
+     Without Prefer, returns the existing paginated FHIR searchset. Send Prefer: respond-async without
+    query parameters to prepare health-records.json in the background. The file is a FHIR collection
+    Bundle containing the captured provider sources, including each source's Patient and warnings for
+    incomplete sources. It has no paging links, search metadata or total field, and is not a Bulk Data
+    $export/NDJSON response. Poll Content-Location with the same consent token no sooner than Retry-
+    After for a 303 download redirect. An organization can hold 20 exports in flight at once; a repeat
+    request for one already running reuses it. Payer records are not included.
+
+    Args:
+        field_count (int | Unset):
+        field_offset (int | Unset):
+        prefer (ExportPatientFhirPrefer | 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[ExportPatientFhirResponse202 | FhirResource | OperationOutcome]
+    """
+
+    kwargs = _get_kwargs(
+        field_count=field_count,
+        field_offset=field_offset,
+        prefer=prefer,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    field_count: int | Unset = UNSET,
+    field_offset: int | Unset = UNSET,
+    prefer: ExportPatientFhirPrefer | Unset = UNSET,
+) -> ExportPatientFhirResponse202 | FhirResource | OperationOutcome | None:
+    """Read or asynchronously export the patient's FHIR record
+
+     Without Prefer, returns the existing paginated FHIR searchset. Send Prefer: respond-async without
+    query parameters to prepare health-records.json in the background. The file is a FHIR collection
+    Bundle containing the captured provider sources, including each source's Patient and warnings for
+    incomplete sources. It has no paging links, search metadata or total field, and is not a Bulk Data
+    $export/NDJSON response. Poll Content-Location with the same consent token no sooner than Retry-
+    After for a 303 download redirect. An organization can hold 20 exports in flight at once; a repeat
+    request for one already running reuses it. Payer records are not included.
+
+    Args:
+        field_count (int | Unset):
+        field_offset (int | Unset):
+        prefer (ExportPatientFhirPrefer | 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:
+        ExportPatientFhirResponse202 | FhirResource | OperationOutcome
+    """
+
+    return sync_detailed(
+        client=client,
+        field_count=field_count,
+        field_offset=field_offset,
+        prefer=prefer,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    field_count: int | Unset = UNSET,
+    field_offset: int | Unset = UNSET,
+    prefer: ExportPatientFhirPrefer | Unset = UNSET,
+) -> Response[ExportPatientFhirResponse202 | FhirResource | OperationOutcome]:
+    """Read or asynchronously export the patient's FHIR record
+
+     Without Prefer, returns the existing paginated FHIR searchset. Send Prefer: respond-async without
+    query parameters to prepare health-records.json in the background. The file is a FHIR collection
+    Bundle containing the captured provider sources, including each source's Patient and warnings for
+    incomplete sources. It has no paging links, search metadata or total field, and is not a Bulk Data
+    $export/NDJSON response. Poll Content-Location with the same consent token no sooner than Retry-
+    After for a 303 download redirect. An organization can hold 20 exports in flight at once; a repeat
+    request for one already running reuses it. Payer records are not included.
+
+    Args:
+        field_count (int | Unset):
+        field_offset (int | Unset):
+        prefer (ExportPatientFhirPrefer | 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[ExportPatientFhirResponse202 | FhirResource | OperationOutcome]
+    """
+
+    kwargs = _get_kwargs(
+        field_count=field_count,
+        field_offset=field_offset,
+        prefer=prefer,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    field_count: int | Unset = UNSET,
+    field_offset: int | Unset = UNSET,
+    prefer: ExportPatientFhirPrefer | Unset = UNSET,
+) -> ExportPatientFhirResponse202 | FhirResource | OperationOutcome | None:
+    """Read or asynchronously export the patient's FHIR record
+
+     Without Prefer, returns the existing paginated FHIR searchset. Send Prefer: respond-async without
+    query parameters to prepare health-records.json in the background. The file is a FHIR collection
+    Bundle containing the captured provider sources, including each source's Patient and warnings for
+    incomplete sources. It has no paging links, search metadata or total field, and is not a Bulk Data
+    $export/NDJSON response. Poll Content-Location with the same consent token no sooner than Retry-
+    After for a 303 download redirect. An organization can hold 20 exports in flight at once; a repeat
+    request for one already running reuses it. Payer records are not included.
+
+    Args:
+        field_count (int | Unset):
+        field_offset (int | Unset):
+        prefer (ExportPatientFhirPrefer | 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:
+        ExportPatientFhirResponse202 | FhirResource | OperationOutcome
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            field_count=field_count,
+            field_offset=field_offset,
+            prefer=prefer,
+        )
+    ).parsed

hubble_sdk/_generated/api/default/export_patient_pdf.py

@@ -5,6 +5,8 @@ import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
+from ...models.export_patient_pdf_prefer import ExportPatientPdfPrefer
+from ...models.export_patient_pdf_response_202 import ExportPatientPdfResponse202
 from ...models.operation_outcome import OperationOutcome
 from ...types import UNSET, Response, Unset
 
@@ -12,7 +14,11 @@ from ...types import UNSET, Response, Unset
 def _get_kwargs(
     *,
     connection: str | Unset = UNSET,
+    prefer: ExportPatientPdfPrefer | Unset = UNSET,
 ) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(prefer, Unset):
+        headers["Prefer"] = str(prefer)
 
     params: dict[str, Any] = {}
 
@@ -26,12 +32,18 @@ def _get_kwargs(
         "params": params,
     }
 
+    _kwargs["headers"] = headers
     return _kwargs
 
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> OperationOutcome | None:
+) -> ExportPatientPdfResponse202 | OperationOutcome | None:
+    if response.status_code == 202:
+        response_202 = ExportPatientPdfResponse202.from_dict(response.json())
+
+        return response_202
+
     if response.status_code == 401:
         response_401 = OperationOutcome.from_dict(response.json())
 
@@ -47,6 +59,16 @@ def _parse_response(
 
         return response_404
 
+    if response.status_code == 429:
+        response_429 = OperationOutcome.from_dict(response.json())
+
+        return response_429
+
+    if response.status_code == 503:
+        response_503 = OperationOutcome.from_dict(response.json())
+
+        return response_503
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
@@ -55,7 +77,7 @@ def _parse_response(
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[OperationOutcome]:
+) -> Response[ExportPatientPdfResponse202 | OperationOutcome]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -68,28 +90,35 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
     connection: str | Unset = UNSET,
-) -> Response[OperationOutcome]:
+    prefer: ExportPatientPdfPrefer | Unset = UNSET,
+) -> Response[ExportPatientPdfResponse202 | OperationOutcome]:
     """Export records as PDF (one per source)
 
      A branded PDF of the patient's records, one per connected source (facility). By default returns a
     zip with a PDF per source plus a `manifest.json` naming each file and reporting its completeness
     (complete / partial / failed); pass `connection=<id>` to get that single source's PDF. The
     `X-Hubble-Sources-Total`, `X-Hubble-Sources-Failed`, and `X-Hubble-Resource-Count` response headers
-    report how many sources were exported, how many were incomplete, and the total resource count.
+    report how many sources were exported, how many were incomplete, and the total resource count. Send
+    Prefer: respond-async to prepare the export in a background worker. Poll Content-Location with the
+    same consent token no sooner than Retry-After until it returns a 303 redirect to a short-lived
+    download URL. An organization can hold 20 exports in flight at once; a repeat request for one
+    already running reuses it. Without Prefer, the synchronous response is unchanged.
 
     Args:
         connection (str | Unset):
+        prefer (ExportPatientPdfPrefer | 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[OperationOutcome]
+        Response[ExportPatientPdfResponse202 | OperationOutcome]
     """
 
     kwargs = _get_kwargs(
         connection=connection,
+        prefer=prefer,
     )
 
     response = client.get_httpx_client().request(
@@ -103,29 +132,36 @@ def sync(
     *,
     client: AuthenticatedClient,
     connection: str | Unset = UNSET,
-) -> OperationOutcome | None:
+    prefer: ExportPatientPdfPrefer | Unset = UNSET,
+) -> ExportPatientPdfResponse202 | OperationOutcome | None:
     """Export records as PDF (one per source)
 
      A branded PDF of the patient's records, one per connected source (facility). By default returns a
     zip with a PDF per source plus a `manifest.json` naming each file and reporting its completeness
     (complete / partial / failed); pass `connection=<id>` to get that single source's PDF. The
     `X-Hubble-Sources-Total`, `X-Hubble-Sources-Failed`, and `X-Hubble-Resource-Count` response headers
-    report how many sources were exported, how many were incomplete, and the total resource count.
+    report how many sources were exported, how many were incomplete, and the total resource count. Send
+    Prefer: respond-async to prepare the export in a background worker. Poll Content-Location with the
+    same consent token no sooner than Retry-After until it returns a 303 redirect to a short-lived
+    download URL. An organization can hold 20 exports in flight at once; a repeat request for one
+    already running reuses it. Without Prefer, the synchronous response is unchanged.
 
     Args:
         connection (str | Unset):
+        prefer (ExportPatientPdfPrefer | 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:
-        OperationOutcome
+        ExportPatientPdfResponse202 | OperationOutcome
     """
 
     return sync_detailed(
         client=client,
         connection=connection,
+        prefer=prefer,
     ).parsed
 
 
@@ -133,28 +169,35 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
     connection: str | Unset = UNSET,
-) -> Response[OperationOutcome]:
+    prefer: ExportPatientPdfPrefer | Unset = UNSET,
+) -> Response[ExportPatientPdfResponse202 | OperationOutcome]:
     """Export records as PDF (one per source)
 
      A branded PDF of the patient's records, one per connected source (facility). By default returns a
     zip with a PDF per source plus a `manifest.json` naming each file and reporting its completeness
     (complete / partial / failed); pass `connection=<id>` to get that single source's PDF. The
     `X-Hubble-Sources-Total`, `X-Hubble-Sources-Failed`, and `X-Hubble-Resource-Count` response headers
-    report how many sources were exported, how many were incomplete, and the total resource count.
+    report how many sources were exported, how many were incomplete, and the total resource count. Send
+    Prefer: respond-async to prepare the export in a background worker. Poll Content-Location with the
+    same consent token no sooner than Retry-After until it returns a 303 redirect to a short-lived
+    download URL. An organization can hold 20 exports in flight at once; a repeat request for one
+    already running reuses it. Without Prefer, the synchronous response is unchanged.
 
     Args:
         connection (str | Unset):
+        prefer (ExportPatientPdfPrefer | 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[OperationOutcome]
+        Response[ExportPatientPdfResponse202 | OperationOutcome]
     """
 
     kwargs = _get_kwargs(
         connection=connection,
+        prefer=prefer,
     )
 
     response = await client.get_async_httpx_client().request(**kwargs)
@@ -166,29 +209,36 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
     connection: str | Unset = UNSET,
-) -> OperationOutcome | None:
+    prefer: ExportPatientPdfPrefer | Unset = UNSET,
+) -> ExportPatientPdfResponse202 | OperationOutcome | None:
     """Export records as PDF (one per source)
 
      A branded PDF of the patient's records, one per connected source (facility). By default returns a
     zip with a PDF per source plus a `manifest.json` naming each file and reporting its completeness
     (complete / partial / failed); pass `connection=<id>` to get that single source's PDF. The
     `X-Hubble-Sources-Total`, `X-Hubble-Sources-Failed`, and `X-Hubble-Resource-Count` response headers
-    report how many sources were exported, how many were incomplete, and the total resource count.
+    report how many sources were exported, how many were incomplete, and the total resource count. Send
+    Prefer: respond-async to prepare the export in a background worker. Poll Content-Location with the
+    same consent token no sooner than Retry-After until it returns a 303 redirect to a short-lived
+    download URL. An organization can hold 20 exports in flight at once; a repeat request for one
+    already running reuses it. Without Prefer, the synchronous response is unchanged.
 
     Args:
         connection (str | Unset):
+        prefer (ExportPatientPdfPrefer | 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:
-        OperationOutcome
+        ExportPatientPdfResponse202 | OperationOutcome
     """
 
     return (
         await asyncio_detailed(
             client=client,
             connection=connection,
+            prefer=prefer,
         )
     ).parsed