hubble-sdk-python 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

hubble_sdk/__init__.py

@@ -5,10 +5,12 @@ Import the high-level client from here:
     from hubble_sdk import Hubble
 
     hub = Hubble(client_id="hbl_client_...", client_secret="hbl_prod_...")
-    link = hub.create_link(patient_ref="abc123")
-    print(link.verification_uri_complete)     # send the patient here
-    session = hub.wait_for_authorization(link)
-    bundle = session.everything()             # reads FHIR with the consent token
+    consent = hub.create_consent(patient_ref="abc123")
+    print(consent.link_url)                     # send the patient here
+    bundle = hub.everything(consent.id)         # read whenever you like
+
+The device flow (``create_link`` / ``wait_for_authorization``) still works for
+existing integrations.
 
 The generated low-level client lives under ``hubble_sdk._generated``
 if you need direct access to raw operations and models.
@@ -17,6 +19,7 @@ if you need direct access to raw operations and models.
 from ._generated.models import (
     Consent,
     ConsentStatus,
+    CreatedConsent,
     DeviceAuthorizationResponse,
     TokenResponse,
 )
@@ -28,6 +31,15 @@ from ._hubble import (
     PdfExport,
     TokenSet,
 )
+from ._params import (
+    ConsentStatusFilter,
+    DiscloserParams,
+    FacilityAddressParams,
+    PatientAddressParams,
+    PatientParams,
+    ProviderSeedParams,
+    UsStateCode,
+)
 from ._webhooks import (
     WEBHOOK_SIGNATURE_HEADER,
     WebhookEvent,
@@ -43,6 +55,13 @@ __all__ = [
     "ConsentTimeout",
     "TokenSet",
     "PdfExport",
+    "ConsentStatusFilter",
+    "PatientParams",
+    "PatientAddressParams",
+    "ProviderSeedParams",
+    "DiscloserParams",
+    "FacilityAddressParams",
+    "UsStateCode",
     "construct_webhook_event",
     "WebhookEvent",
     "WebhookEventSource",
@@ -50,6 +69,7 @@ __all__ = [
     "WEBHOOK_SIGNATURE_HEADER",
     "Consent",
     "ConsentStatus",
+    "CreatedConsent",
     "DeviceAuthorizationResponse",
     "TokenResponse",
 ]

hubble_sdk/_generated/api/default/create_consent.py

@@ -0,0 +1,193 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_error import ApiError
+from ...models.consent_link_request import ConsentLinkRequest
+from ...models.created_consent import CreatedConsent
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    body: ConsentLinkRequest | Unset = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/consents",
+    }
+
+    if not isinstance(body, Unset):
+        _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ApiError | CreatedConsent | None:
+    if response.status_code == 201:
+        response_201 = CreatedConsent.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 400:
+        response_400 = ApiError.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = ApiError.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = ApiError.from_dict(response.json())
+
+        return response_403
+
+    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[ApiError | CreatedConsent]:
+    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: ConsentLinkRequest | Unset = UNSET,
+) -> Response[ApiError | CreatedConsent]:
+    """Create a consent
+
+     Creates a pending consent and its patient link, and returns the consent with `link_url`. Deliver the
+    link to the patient, then read the consent with an application access token from POST /api/v1/token
+    and `consent=<id>` on /api/v1/fhir. Every field is optional.
+
+    Args:
+        body (ConsentLinkRequest | 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[ApiError | CreatedConsent]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: ConsentLinkRequest | Unset = UNSET,
+) -> ApiError | CreatedConsent | None:
+    """Create a consent
+
+     Creates a pending consent and its patient link, and returns the consent with `link_url`. Deliver the
+    link to the patient, then read the consent with an application access token from POST /api/v1/token
+    and `consent=<id>` on /api/v1/fhir. Every field is optional.
+
+    Args:
+        body (ConsentLinkRequest | 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:
+        ApiError | CreatedConsent
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: ConsentLinkRequest | Unset = UNSET,
+) -> Response[ApiError | CreatedConsent]:
+    """Create a consent
+
+     Creates a pending consent and its patient link, and returns the consent with `link_url`. Deliver the
+    link to the patient, then read the consent with an application access token from POST /api/v1/token
+    and `consent=<id>` on /api/v1/fhir. Every field is optional.
+
+    Args:
+        body (ConsentLinkRequest | 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[ApiError | CreatedConsent]
+    """
+
+    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: ConsentLinkRequest | Unset = UNSET,
+) -> ApiError | CreatedConsent | None:
+    """Create a consent
+
+     Creates a pending consent and its patient link, and returns the consent with `link_url`. Deliver the
+    link to the patient, then read the consent with an application access token from POST /api/v1/token
+    and `consent=<id>` on /api/v1/fhir. Every field is optional.
+
+    Args:
+        body (ConsentLinkRequest | 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:
+        ApiError | CreatedConsent
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

hubble_sdk/_generated/api/default/create_consent_link.py

@@ -77,7 +77,8 @@ def sync_detailed(
      Mints a pending consent and a one-time patient link. Send the patient to
     `verification_uri_complete`, then poll the token endpoint with `device_code` until they authorize.
     Accepts a nested JSON body (recommended) or the flat RFC 8628 form encoding; both prefill the same
-    consent.
+    consent. To read with an application access token instead, create the consent with POST
+    /api/v1/consents, which has no device code.
 
     Args:
         body (ConsentLinkRequest | Unset):
@@ -112,7 +113,8 @@ def sync(
      Mints a pending consent and a one-time patient link. Send the patient to
     `verification_uri_complete`, then poll the token endpoint with `device_code` until they authorize.
     Accepts a nested JSON body (recommended) or the flat RFC 8628 form encoding; both prefill the same
-    consent.
+    consent. To read with an application access token instead, create the consent with POST
+    /api/v1/consents, which has no device code.
 
     Args:
         body (ConsentLinkRequest | Unset):
@@ -142,7 +144,8 @@ async def asyncio_detailed(
      Mints a pending consent and a one-time patient link. Send the patient to
     `verification_uri_complete`, then poll the token endpoint with `device_code` until they authorize.
     Accepts a nested JSON body (recommended) or the flat RFC 8628 form encoding; both prefill the same
-    consent.
+    consent. To read with an application access token instead, create the consent with POST
+    /api/v1/consents, which has no device code.
 
     Args:
         body (ConsentLinkRequest | Unset):
@@ -175,7 +178,8 @@ async def asyncio(
      Mints a pending consent and a one-time patient link. Send the patient to
     `verification_uri_complete`, then poll the token endpoint with `device_code` until they authorize.
     Accepts a nested JSON body (recommended) or the flat RFC 8628 form encoding; both prefill the same
-    consent.
+    consent. To read with an application access token instead, create the consent with POST
+    /api/v1/consents, which has no device code.
 
     Args:
         body (ConsentLinkRequest | Unset):

hubble_sdk/_generated/api/default/export_patient_fhir.py

@@ -1,5 +1,6 @@
 from http import HTTPStatus
 from typing import Any
+from uuid import UUID
 
 import httpx
 
@@ -14,6 +15,7 @@ from ...types import UNSET, Response, Unset
 
 def _get_kwargs(
     *,
+    consent: UUID | Unset = UNSET,
     field_count: int | Unset = UNSET,
     field_offset: int | Unset = UNSET,
     prefer: ExportPatientFhirPrefer | Unset = UNSET,
@@ -24,6 +26,11 @@ def _get_kwargs(
 
     params: dict[str, Any] = {}
 
+    json_consent: str | Unset = UNSET
+    if not isinstance(consent, Unset):
+        json_consent = str(consent)
+    params["consent"] = json_consent
+
     params["_count"] = field_count
 
     params["_offset"] = field_offset
@@ -103,6 +110,7 @@ def _build_response(
 def sync_detailed(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     field_count: int | Unset = UNSET,
     field_offset: int | Unset = UNSET,
     prefer: ExportPatientFhirPrefer | Unset = UNSET,
@@ -113,11 +121,12 @@ def sync_detailed(
     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.
+    $export/NDJSON response. Poll Content-Location with the same 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:
+        consent (UUID | Unset):
         field_count (int | Unset):
         field_offset (int | Unset):
         prefer (ExportPatientFhirPrefer | Unset):
@@ -131,6 +140,7 @@ def sync_detailed(
     """
 
     kwargs = _get_kwargs(
+        consent=consent,
         field_count=field_count,
         field_offset=field_offset,
         prefer=prefer,
@@ -146,6 +156,7 @@ def sync_detailed(
 def sync(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     field_count: int | Unset = UNSET,
     field_offset: int | Unset = UNSET,
     prefer: ExportPatientFhirPrefer | Unset = UNSET,
@@ -156,11 +167,12 @@ def sync(
     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.
+    $export/NDJSON response. Poll Content-Location with the same 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:
+        consent (UUID | Unset):
         field_count (int | Unset):
         field_offset (int | Unset):
         prefer (ExportPatientFhirPrefer | Unset):
@@ -175,6 +187,7 @@ def sync(
 
     return sync_detailed(
         client=client,
+        consent=consent,
         field_count=field_count,
         field_offset=field_offset,
         prefer=prefer,
@@ -184,6 +197,7 @@ def sync(
 async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     field_count: int | Unset = UNSET,
     field_offset: int | Unset = UNSET,
     prefer: ExportPatientFhirPrefer | Unset = UNSET,
@@ -194,11 +208,12 @@ async def asyncio_detailed(
     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.
+    $export/NDJSON response. Poll Content-Location with the same 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:
+        consent (UUID | Unset):
         field_count (int | Unset):
         field_offset (int | Unset):
         prefer (ExportPatientFhirPrefer | Unset):
@@ -212,6 +227,7 @@ async def asyncio_detailed(
     """
 
     kwargs = _get_kwargs(
+        consent=consent,
         field_count=field_count,
         field_offset=field_offset,
         prefer=prefer,
@@ -225,6 +241,7 @@ async def asyncio_detailed(
 async def asyncio(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     field_count: int | Unset = UNSET,
     field_offset: int | Unset = UNSET,
     prefer: ExportPatientFhirPrefer | Unset = UNSET,
@@ -235,11 +252,12 @@ async def asyncio(
     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.
+    $export/NDJSON response. Poll Content-Location with the same 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:
+        consent (UUID | Unset):
         field_count (int | Unset):
         field_offset (int | Unset):
         prefer (ExportPatientFhirPrefer | Unset):
@@ -255,6 +273,7 @@ async def asyncio(
     return (
         await asyncio_detailed(
             client=client,
+            consent=consent,
             field_count=field_count,
             field_offset=field_offset,
             prefer=prefer,

hubble_sdk/_generated/api/default/export_patient_pdf.py

@@ -1,5 +1,6 @@
 from http import HTTPStatus
 from typing import Any
+from uuid import UUID
 
 import httpx
 
@@ -13,6 +14,7 @@ from ...types import UNSET, Response, Unset
 
 def _get_kwargs(
     *,
+    consent: UUID | Unset = UNSET,
     connection: str | Unset = UNSET,
     prefer: ExportPatientPdfPrefer | Unset = UNSET,
 ) -> dict[str, Any]:
@@ -22,6 +24,11 @@ def _get_kwargs(
 
     params: dict[str, Any] = {}
 
+    json_consent: str | Unset = UNSET
+    if not isinstance(consent, Unset):
+        json_consent = str(consent)
+    params["consent"] = json_consent
+
     params["connection"] = connection
 
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
@@ -44,6 +51,11 @@ def _parse_response(
 
         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())
 
@@ -89,6 +101,7 @@ def _build_response(
 def sync_detailed(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     connection: str | Unset = UNSET,
     prefer: ExportPatientPdfPrefer | Unset = UNSET,
 ) -> Response[ExportPatientPdfResponse202 | OperationOutcome]:
@@ -100,11 +113,12 @@ def sync_detailed(
     `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. 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.
+    same 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:
+        consent (UUID | Unset):
         connection (str | Unset):
         prefer (ExportPatientPdfPrefer | Unset):
 
@@ -117,6 +131,7 @@ def sync_detailed(
     """
 
     kwargs = _get_kwargs(
+        consent=consent,
         connection=connection,
         prefer=prefer,
     )
@@ -131,6 +146,7 @@ def sync_detailed(
 def sync(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     connection: str | Unset = UNSET,
     prefer: ExportPatientPdfPrefer | Unset = UNSET,
 ) -> ExportPatientPdfResponse202 | OperationOutcome | None:
@@ -142,11 +158,12 @@ def sync(
     `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. 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.
+    same 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:
+        consent (UUID | Unset):
         connection (str | Unset):
         prefer (ExportPatientPdfPrefer | Unset):
 
@@ -160,6 +177,7 @@ def sync(
 
     return sync_detailed(
         client=client,
+        consent=consent,
         connection=connection,
         prefer=prefer,
     ).parsed
@@ -168,6 +186,7 @@ def sync(
 async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     connection: str | Unset = UNSET,
     prefer: ExportPatientPdfPrefer | Unset = UNSET,
 ) -> Response[ExportPatientPdfResponse202 | OperationOutcome]:
@@ -179,11 +198,12 @@ async def asyncio_detailed(
     `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. 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.
+    same 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:
+        consent (UUID | Unset):
         connection (str | Unset):
         prefer (ExportPatientPdfPrefer | Unset):
 
@@ -196,6 +216,7 @@ async def asyncio_detailed(
     """
 
     kwargs = _get_kwargs(
+        consent=consent,
         connection=connection,
         prefer=prefer,
     )
@@ -208,6 +229,7 @@ async def asyncio_detailed(
 async def asyncio(
     *,
     client: AuthenticatedClient,
+    consent: UUID | Unset = UNSET,
     connection: str | Unset = UNSET,
     prefer: ExportPatientPdfPrefer | Unset = UNSET,
 ) -> ExportPatientPdfResponse202 | OperationOutcome | None:
@@ -219,11 +241,12 @@ async def asyncio(
     `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. 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.
+    same 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:
+        consent (UUID | Unset):
         connection (str | Unset):
         prefer (ExportPatientPdfPrefer | Unset):
 
@@ -238,6 +261,7 @@ async def asyncio(
     return (
         await asyncio_detailed(
             client=client,
+            consent=consent,
             connection=connection,
             prefer=prefer,
         )