diff --git a/.fern/metadata.json b/.fern/metadata.json
index d3cb91c8..fc3099e0 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,7 +1,7 @@
{
- "cliVersion": "3.35.1",
+ "cliVersion": "4.66.0",
"generatorName": "fernapi/fern-python-sdk",
- "generatorVersion": "4.46.6",
+ "generatorVersion": "4.60.1",
"generatorConfig": {
"client_class_name": "Vital",
"inline_request_params": false,
@@ -10,5 +10,6 @@
"use_pydantic_field_aliases": true
}
},
- "sdkVersion": "2.1.569"
+ "originGitCommit": "6347981d44f9d73cff1e67ebed52cf9d3f0927c8",
+ "sdkVersion": "3.0.0"
}
\ No newline at end of file
diff --git a/.fernignore b/.fernignore
index 43ca0d22..07281cd7 100644
--- a/.fernignore
+++ b/.fernignore
@@ -1,3 +1,4 @@
# Specify files that shouldn't be modified by Fern
README.md
+changelog.md
diff --git a/changelog.md b/changelog.md
new file mode 100644
index 00000000..a6ef4102
--- /dev/null
+++ b/changelog.md
@@ -0,0 +1,42 @@
+## 3.0.0 - 2026-04-10
+* Several breaking changes have been made in this release:
+* The `INSULIN_INJECTION` enum value has been removed from `IntervalTimeseriesExprTimeseries`. Callers using `.visit(insulin_injection=...)` must remove that argument.
+* The `LinkBulkExportRequestTeamId`, `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`, `LinkBulkTriggerHistoricalPullRequestTeamId`, and `LinkListBulkOpsRequestTeamId` types have been removed from `vital.link`.
+* `AppointmentPscLabs` has changed from a `Literal["quest"]` type alias to a `StrEnum` class â code using it as a plain string type annotation may need updating.
+* New in this release: HTTP requests now support structured logging (debug and error) with automatic redaction of sensitive headers; `BaseHttpResponse` exposes a new `status_code` property; and `AppointmentPscLabs` now includes the `SONORA_QUEST` value.
+* **Breaking changes:**
+* The `file` parameter of `parser_create_job` (on both `LabReportClient` and `AsyncLabReportClient`) has changed from `core.File` to `typing.List[core.File]`. Callers must now wrap a single file in a list: `file=[my_file]`.
+* The following types have been removed from the top-level `vital` package: `LinkBulkExportRequestTeamId`, `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`, `LinkBulkTriggerHistoricalPullRequestTeamId`, and `LinkListBulkOpsRequestTeamId`.
+**New features:**
+* Three new resource submodules are now available: `vital.compendium`, `vital.lab_account`, and `vital.order_transaction`.
+* Over 40 new public types have been added, including `CanonicalCandidate`, `ClientFacingLabAccount`, `ClientFacingOrderTransaction`, `InsulinInjectionTimeseriesExpr`, `OrderSummary`, `SearchCompendiumResponse`, `UsState`, `UserAddress`, and more.
+* Client wrappers now accept an optional `logging` parameter for structured request/response logging (`LogConfig` or `Logger`).
+* The `LabTestsClient` (sync and async) has been expanded with several new parameters and types:
+* `get_psc_appointment_availability` now accepts a required `lab` parameter (`AppointmentPscLabs`) and a new optional `allow_stale` flag for cached availability data.
+* `book_psc_appointment` now supports optional `idempotency_key` and `idempotency_error` parameters for idempotent PSC appointment booking (currently in closed beta).
+* `create_lab_test` accepts new optional `lab_account_id` and `lab_slug` (`Labs`) parameters.
+* `get_markers` accepts a new optional `lab_slug` parameter to filter markers by lab slug.
+* `get_orders` accepts a new optional `order_transaction_id` parameter for filtering.
+* `request_phlebotomy_appointment` accepts a new optional `appointment_notes` parameter.
+* `create_order` accepts a new optional `clinical_notes` parameter.
+* New types `AppointmentPscLabs` and `Labs` are now available for use with these methods.
+* The `get_psc_appointment_availability` method now requires a `lab` parameter (of type `AppointmentPscLabs`) that was previously hardcoded to `"quest"`. Callers must now explicitly pass the desired lab value. Additionally, many lab test and appointment methods have new optional parameters: `lab_account_id`, `lab_slug`, `order_transaction_id`, `appointment_notes`, `allow_stale`, `clinical_notes`, and idempotency support (`idempotency_key`, `idempotency_error`) for PSC appointment booking.
+* The `team_id` parameter has been removed from `link.list_bulk_ops()`, `link.bulk_import()`, `link.bulk_trigger_historical_pull()`, `link.bulk_export()`, and `link.bulk_pause()` â callers using this keyword argument must remove it. The associated enum types (`LinkBulkExportRequestTeamId`, `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`, `LinkBulkTriggerHistoricalPullRequestTeamId`, `LinkListBulkOpsRequestTeamId`) have also been removed.
+* `link.connect_manual_provider()` now accepts three new optional parameters: `vital_ios_sdk_version`, `vital_android_sdk_version`, and `granted_permissions`, enabling mobile SDK version reporting and explicit permission grants.
+* The SDK introduces several breaking changes alongside new features.
+**Breaking changes:**
+* The `address` parameter type in user creation/update methods (`UserClient`, `RawUserClient`) has changed from `Address` to `UserAddress`. Update all imports and usages accordingly (e.g., replace `from vital import Address` with `from vital import UserAddress`).
+* `ParsingJob.job_id` has been removed. Use `ParsingJob.id` to identify parsing jobs.
+* `Jpeg.content` and `Png.content` now use `bytes` instead of `str`.
+**New features:**
+* Three new top-level clients are now available on `Vital` and `AsyncVital`: `compendium`, `lab_account`, and `order_transaction`.
+* A new optional `logging` parameter is available on `Vital` and `AsyncVital` constructors, accepting a `LogConfig` dict or a `Logger` instance for configurable SDK-level logging.
+* `ClientFacingOrder` now exposes `last_event`, `clinical_notes`, `origin`, and `order_transaction` fields.
+* `ClientFacingInsulinInjectionSample` gains optional `delivery_mode`, `delivery_form`, and `bolus_purpose` fields.
+* `OrderStatus` includes new enum values for corrected results and lab-processing-blocked states.
+* The SDK now includes two new client namespaces: `compendium` (with `search` and `convert` methods for lab test discovery and cross-lab conversion) and `lab_account` (with `get_team_lab_accounts` for managing team lab accounts). A new structured logging module (`ILogger`, `ConsoleLogger`, `LogConfig`, `Logger`, `create_logger`) is also available via `vital.core`.
+* The SDK now includes a new `order_transaction` client namespace with three methods: `get_transaction()`, `get_transaction_result()`, and `get_transaction_result_pdf()`. These methods provide access to order transaction details, raw lab results, and streamable PDF lab result reports respectively. Both synchronous and asynchronous variants are available.
+* The SDK now exposes many new types and enum values. New types include lab account management (`ClientFacingLabAccount`, `GetTeamLabAccountsResponse`, `LabAccountDelegatedFlow`, `LabAccountStatus`), order transactions (`ClientFacingOrderTransaction`, `ClientFacingOrderInTransaction`, `GetOrderTransactionResponse`, `OrderTransactionStatus`, `OrderOrigin`, `OrderStatusDetail`, `OrderSummary`), compendium search (`SearchCompendiumResponse`, `CompendiumSearchLabs`, `ConvertCompendiumResponse`, `SearchMode`, `CanonicalCandidate`, `PerLabCandidate`, `RelatedCandidate`), insulin injection details (`ClientFacingInsulinInjectionSampleBolusPurpose`, `ClientFacingInsulinInjectionSampleDeliveryForm`, `ClientFacingInsulinInjectionSampleDeliveryMode`), and sleep analytics (`AwakeningsValueMacroExpr`, `DerivedReadinessColumnExpr`). Several existing models have gained new optional fields, and new enum values have been added to `AppointmentProvider` (`SONORA_QUEST`) and source-type enums (`INSULIN_PUMP`).
+* The SDK now includes new types and fields to support insulin injection timeseries, lab account management, order transactions, lab report parsing job webhook events, and compendium search/conversion. New optional fields `recovery_readiness_score` (on `ClientFacingSleep`), `status_detail` (on `ClientFacingOrderEvent`), and `order_transaction` (on `LabResultsRaw`) are also available. Several enums have been expanded with new values including `SONORA_QUEST`, `CRL`, `SAMSUNG_HEALTH`, `INSULIN_PUMP`, `CORRECTED`, `LAB_PROCESSING_BLOCKED`, and `DERIVED_READINESS`.
+* The SDK now includes several new types and capabilities: `OrderStatusDetail`, `OrderTransactionStatus`, and `OrderSummary` for richer order lifecycle tracking; `SearchCompendiumResponse`, `PerLabCandidate`, `RelatedCandidate`, and `ProviderIdConversionResponse` for compendium search and provider ID conversion; and `UserAddress` with `UsState` enum for US address handling. New providers `TANDEM_SOURCE` and `SAMSUNG_HEALTH` have been added to the `Providers` enum, `TANDEM_SOURCE` to `PasswordProviders`, and `APERO`/`PVERIFY` to `PayorCodeExternalProvider`. Address models (`PatientAddress`, `PatientAddressCompatible`, `PatientAddressWithValidation`, `UsAddress`) now include an optional `access_notes` field, and query expression union types have been expanded with `AwakeningsValueMacroExpr`, `DerivedReadinessColumnExpr`, and `InsulinInjectionTimeseriesExpr`.
+
diff --git a/poetry.lock b/poetry.lock
index ea0fda47..fdfe7802 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"]
[[package]]
name = "certifi"
-version = "2026.1.4"
+version = "2026.2.25"
description = "Python package for providing Mozilla's CA Bundle."
optional = false
python-versions = ">=3.7"
files = [
- {file = "certifi-2026.1.4-py3-none-any.whl", hash = "sha256:9943707519e4add1115f44c2bc244f782c0249876bf51b6599fee1ffbedd685c"},
- {file = "certifi-2026.1.4.tar.gz", hash = "sha256:ac726dd470482006e014ad384921ed6438c457018f4b3d204aea4281258b2120"},
+ {file = "certifi-2026.2.25-py3-none-any.whl", hash = "sha256:027692e4402ad994f1c42e52a4997a9763c646b73e4096e4d5d6db8af1d6f0fa"},
+ {file = "certifi-2026.2.25.tar.gz", hash = "sha256:e887ab5cee78ea814d3472169153c2d12cd43b14bd03329a39a9c6e2e80bfba7"},
]
[[package]]
@@ -236,13 +236,13 @@ files = [
[[package]]
name = "packaging"
-version = "25.0"
+version = "26.0"
description = "Core utilities for Python packages"
optional = false
python-versions = ">=3.8"
files = [
- {file = "packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484"},
- {file = "packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f"},
+ {file = "packaging-26.0-py3-none-any.whl", hash = "sha256:b36f1fef9334a5588b4166f8bcd26a14e521f2b55e6b9de3aaa80d3ff7a37529"},
+ {file = "packaging-26.0.tar.gz", hash = "sha256:00243ae351a257117b6a241061796684b084ed1c516a08c48a3f7e147a9d80b4"},
]
[[package]]
@@ -517,58 +517,58 @@ files = [
[[package]]
name = "tomli"
-version = "2.4.0"
+version = "2.4.1"
description = "A lil' TOML parser"
optional = false
python-versions = ">=3.8"
files = [
- {file = "tomli-2.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b5ef256a3fd497d4973c11bf142e9ed78b150d36f5773f1ca6088c230ffc5867"},
- {file = "tomli-2.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5572e41282d5268eb09a697c89a7bee84fae66511f87533a6f88bd2f7b652da9"},
- {file = "tomli-2.4.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:551e321c6ba03b55676970b47cb1b73f14a0a4dce6a3e1a9458fd6d921d72e95"},
- {file = "tomli-2.4.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5e3f639a7a8f10069d0e15408c0b96a2a828cfdec6fca05296ebcdcc28ca7c76"},
- {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1b168f2731796b045128c45982d3a4874057626da0e2ef1fdd722848b741361d"},
- {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:133e93646ec4300d651839d382d63edff11d8978be23da4cc106f5a18b7d0576"},
- {file = "tomli-2.4.0-cp311-cp311-win32.whl", hash = "sha256:b6c78bdf37764092d369722d9946cb65b8767bfa4110f902a1b2542d8d173c8a"},
- {file = "tomli-2.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:d3d1654e11d724760cdb37a3d7691f0be9db5fbdaef59c9f532aabf87006dbaa"},
- {file = "tomli-2.4.0-cp311-cp311-win_arm64.whl", hash = "sha256:cae9c19ed12d4e8f3ebf46d1a75090e4c0dc16271c5bce1c833ac168f08fb614"},
- {file = "tomli-2.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:920b1de295e72887bafa3ad9f7a792f811847d57ea6b1215154030cf131f16b1"},
- {file = "tomli-2.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7d6d9a4aee98fac3eab4952ad1d73aee87359452d1c086b5ceb43ed02ddb16b8"},
- {file = "tomli-2.4.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:36b9d05b51e65b254ea6c2585b59d2c4cb91c8a3d91d0ed0f17591a29aaea54a"},
- {file = "tomli-2.4.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c8a885b370751837c029ef9bc014f27d80840e48bac415f3412e6593bbc18c1"},
- {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8768715ffc41f0008abe25d808c20c3d990f42b6e2e58305d5da280ae7d1fa3b"},
- {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b438885858efd5be02a9a133caf5812b8776ee0c969fea02c45e8e3f296ba51"},
- {file = "tomli-2.4.0-cp312-cp312-win32.whl", hash = "sha256:0408e3de5ec77cc7f81960c362543cbbd91ef883e3138e81b729fc3eea5b9729"},
- {file = "tomli-2.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:685306e2cc7da35be4ee914fd34ab801a6acacb061b6a7abca922aaf9ad368da"},
- {file = "tomli-2.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:5aa48d7c2356055feef06a43611fc401a07337d5b006be13a30f6c58f869e3c3"},
- {file = "tomli-2.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84d081fbc252d1b6a982e1870660e7330fb8f90f676f6e78b052ad4e64714bf0"},
- {file = "tomli-2.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9a08144fa4cba33db5255f9b74f0b89888622109bd2776148f2597447f92a94e"},
- {file = "tomli-2.4.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c73add4bb52a206fd0c0723432db123c0c75c280cbd67174dd9d2db228ebb1b4"},
- {file = "tomli-2.4.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1fb2945cbe303b1419e2706e711b7113da57b7db31ee378d08712d678a34e51e"},
- {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbb1b10aa643d973366dc2cb1ad94f99c1726a02343d43cbc011edbfac579e7c"},
- {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4cbcb367d44a1f0c2be408758b43e1ffb5308abe0ea222897d6bfc8e8281ef2f"},
- {file = "tomli-2.4.0-cp313-cp313-win32.whl", hash = "sha256:7d49c66a7d5e56ac959cb6fc583aff0651094ec071ba9ad43df785abc2320d86"},
- {file = "tomli-2.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:3cf226acb51d8f1c394c1b310e0e0e61fecdd7adcb78d01e294ac297dd2e7f87"},
- {file = "tomli-2.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:d20b797a5c1ad80c516e41bc1fb0443ddb5006e9aaa7bda2d71978346aeb9132"},
- {file = "tomli-2.4.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:26ab906a1eb794cd4e103691daa23d95c6919cc2fa9160000ac02370cc9dd3f6"},
- {file = "tomli-2.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:20cedb4ee43278bc4f2fee6cb50daec836959aadaf948db5172e776dd3d993fc"},
- {file = "tomli-2.4.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39b0b5d1b6dd03684b3fb276407ebed7090bbec989fa55838c98560c01113b66"},
- {file = "tomli-2.4.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a26d7ff68dfdb9f87a016ecfd1e1c2bacbe3108f4e0f8bcd2228ef9a766c787d"},
- {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:20ffd184fb1df76a66e34bd1b36b4a4641bd2b82954befa32fe8163e79f1a702"},
- {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:75c2f8bbddf170e8effc98f5e9084a8751f8174ea6ccf4fca5398436e0320bc8"},
- {file = "tomli-2.4.0-cp314-cp314-win32.whl", hash = "sha256:31d556d079d72db7c584c0627ff3a24c5d3fb4f730221d3444f3efb1b2514776"},
- {file = "tomli-2.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:43e685b9b2341681907759cf3a04e14d7104b3580f808cfde1dfdb60ada85475"},
- {file = "tomli-2.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:3d895d56bd3f82ddd6faaff993c275efc2ff38e52322ea264122d72729dca2b2"},
- {file = "tomli-2.4.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5b5807f3999fb66776dbce568cc9a828544244a8eb84b84b9bafc080c99597b9"},
- {file = "tomli-2.4.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c084ad935abe686bd9c898e62a02a19abfc9760b5a79bc29644463eaf2840cb0"},
- {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0f2e3955efea4d1cfbcb87bc321e00dc08d2bcb737fd1d5e398af111d86db5df"},
- {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e0fe8a0b8312acf3a88077a0802565cb09ee34107813bba1c7cd591fa6cfc8d"},
- {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:413540dce94673591859c4c6f794dfeaa845e98bf35d72ed59636f869ef9f86f"},
- {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:0dc56fef0e2c1c470aeac5b6ca8cc7b640bb93e92d9803ddaf9ea03e198f5b0b"},
- {file = "tomli-2.4.0-cp314-cp314t-win32.whl", hash = "sha256:d878f2a6707cc9d53a1be1414bbb419e629c3d6e67f69230217bb663e76b5087"},
- {file = "tomli-2.4.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2add28aacc7425117ff6364fe9e06a183bb0251b03f986df0e78e974047571fd"},
- {file = "tomli-2.4.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2b1e3b80e1d5e52e40e9b924ec43d81570f0e7d09d11081b797bc4692765a3d4"},
- {file = "tomli-2.4.0-py3-none-any.whl", hash = "sha256:1f776e7d669ebceb01dee46484485f43a4048746235e683bcdffacdf1fb4785a"},
- {file = "tomli-2.4.0.tar.gz", hash = "sha256:aa89c3f6c277dd275d8e243ad24f3b5e701491a860d5121f2cdd399fbb31fc9c"},
+ {file = "tomli-2.4.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f8f0fc26ec2cc2b965b7a3b87cd19c5c6b8c5e5f436b984e85f486d652285c30"},
+ {file = "tomli-2.4.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4ab97e64ccda8756376892c53a72bd1f964e519c77236368527f758fbc36a53a"},
+ {file = "tomli-2.4.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:96481a5786729fd470164b47cdb3e0e58062a496f455ee41b4403be77cb5a076"},
+ {file = "tomli-2.4.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5a881ab208c0baf688221f8cecc5401bd291d67e38a1ac884d6736cbcd8247e9"},
+ {file = "tomli-2.4.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:47149d5bd38761ac8be13a84864bf0b7b70bc051806bc3669ab1cbc56216b23c"},
+ {file = "tomli-2.4.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:ec9bfaf3ad2df51ace80688143a6a4ebc09a248f6ff781a9945e51937008fcbc"},
+ {file = "tomli-2.4.1-cp311-cp311-win32.whl", hash = "sha256:ff2983983d34813c1aeb0fa89091e76c3a22889ee83ab27c5eeb45100560c049"},
+ {file = "tomli-2.4.1-cp311-cp311-win_amd64.whl", hash = "sha256:5ee18d9ebdb417e384b58fe414e8d6af9f4e7a0ae761519fb50f721de398dd4e"},
+ {file = "tomli-2.4.1-cp311-cp311-win_arm64.whl", hash = "sha256:c2541745709bad0264b7d4705ad453b76ccd191e64aa6f0fc66b69a293a45ece"},
+ {file = "tomli-2.4.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:c742f741d58a28940ce01d58f0ab2ea3ced8b12402f162f4d534dfe18ba1cd6a"},
+ {file = "tomli-2.4.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7f86fd587c4ed9dd76f318225e7d9b29cfc5a9d43de44e5754db8d1128487085"},
+ {file = "tomli-2.4.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ff18e6a727ee0ab0388507b89d1bc6a22b138d1e2fa56d1ad494586d61d2eae9"},
+ {file = "tomli-2.4.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:136443dbd7e1dee43c68ac2694fde36b2849865fa258d39bf822c10e8068eac5"},
+ {file = "tomli-2.4.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:5e262d41726bc187e69af7825504c933b6794dc3fbd5945e41a79bb14c31f585"},
+ {file = "tomli-2.4.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:5cb41aa38891e073ee49d55fbc7839cfdb2bc0e600add13874d048c94aadddd1"},
+ {file = "tomli-2.4.1-cp312-cp312-win32.whl", hash = "sha256:da25dc3563bff5965356133435b757a795a17b17d01dbc0f42fb32447ddfd917"},
+ {file = "tomli-2.4.1-cp312-cp312-win_amd64.whl", hash = "sha256:52c8ef851d9a240f11a88c003eacb03c31fc1c9c4ec64a99a0f922b93874fda9"},
+ {file = "tomli-2.4.1-cp312-cp312-win_arm64.whl", hash = "sha256:f758f1b9299d059cc3f6546ae2af89670cb1c4d48ea29c3cacc4fe7de3058257"},
+ {file = "tomli-2.4.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:36d2bd2ad5fb9eaddba5226aa02c8ec3fa4f192631e347b3ed28186d43be6b54"},
+ {file = "tomli-2.4.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:eb0dc4e38e6a1fd579e5d50369aa2e10acfc9cace504579b2faabb478e76941a"},
+ {file = "tomli-2.4.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c7f2c7f2b9ca6bdeef8f0fa897f8e05085923eb091721675170254cbc5b02897"},
+ {file = "tomli-2.4.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f3c6818a1a86dd6dca7ddcaaf76947d5ba31aecc28cb1b67009a5877c9a64f3f"},
+ {file = "tomli-2.4.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:d312ef37c91508b0ab2cee7da26ec0b3ed2f03ce12bd87a588d771ae15dcf82d"},
+ {file = "tomli-2.4.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:51529d40e3ca50046d7606fa99ce3956a617f9b36380da3b7f0dd3dd28e68cb5"},
+ {file = "tomli-2.4.1-cp313-cp313-win32.whl", hash = "sha256:2190f2e9dd7508d2a90ded5ed369255980a1bcdd58e52f7fe24b8162bf9fedbd"},
+ {file = "tomli-2.4.1-cp313-cp313-win_amd64.whl", hash = "sha256:8d65a2fbf9d2f8352685bc1364177ee3923d6baf5e7f43ea4959d7d8bc326a36"},
+ {file = "tomli-2.4.1-cp313-cp313-win_arm64.whl", hash = "sha256:4b605484e43cdc43f0954ddae319fb75f04cc10dd80d830540060ee7cd0243cd"},
+ {file = "tomli-2.4.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:fd0409a3653af6c147209d267a0e4243f0ae46b011aa978b1080359fddc9b6cf"},
+ {file = "tomli-2.4.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:a120733b01c45e9a0c34aeef92bf0cf1d56cfe81ed9d47d562f9ed591a9828ac"},
+ {file = "tomli-2.4.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:559db847dc486944896521f68d8190be1c9e719fced785720d2216fe7022b662"},
+ {file = "tomli-2.4.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:01f520d4f53ef97964a240a035ec2a869fe1a37dde002b57ebc4417a27ccd853"},
+ {file = "tomli-2.4.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7f94b27a62cfad8496c8d2513e1a222dd446f095fca8987fceef261225538a15"},
+ {file = "tomli-2.4.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:ede3e6487c5ef5d28634ba3f31f989030ad6af71edfb0055cbbd14189ff240ba"},
+ {file = "tomli-2.4.1-cp314-cp314-win32.whl", hash = "sha256:3d48a93ee1c9b79c04bb38772ee1b64dcf18ff43085896ea460ca8dec96f35f6"},
+ {file = "tomli-2.4.1-cp314-cp314-win_amd64.whl", hash = "sha256:88dceee75c2c63af144e456745e10101eb67361050196b0b6af5d717254dddf7"},
+ {file = "tomli-2.4.1-cp314-cp314-win_arm64.whl", hash = "sha256:b8c198f8c1805dc42708689ed6864951fd2494f924149d3e4bce7710f8eb5232"},
+ {file = "tomli-2.4.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:d4d8fe59808a54658fcc0160ecfb1b30f9089906c50b23bcb4c69eddc19ec2b4"},
+ {file = "tomli-2.4.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:7008df2e7655c495dd12d2a4ad038ff878d4ca4b81fccaf82b714e07eae4402c"},
+ {file = "tomli-2.4.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1d8591993e228b0c930c4bb0db464bdad97b3289fb981255d6c9a41aedc84b2d"},
+ {file = "tomli-2.4.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:734e20b57ba95624ecf1841e72b53f6e186355e216e5412de414e3c51e5e3c41"},
+ {file = "tomli-2.4.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8a650c2dbafa08d42e51ba0b62740dae4ecb9338eefa093aa5c78ceb546fcd5c"},
+ {file = "tomli-2.4.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:504aa796fe0569bb43171066009ead363de03675276d2d121ac1a4572397870f"},
+ {file = "tomli-2.4.1-cp314-cp314t-win32.whl", hash = "sha256:b1d22e6e9387bf4739fbe23bfa80e93f6b0373a7f1b96c6227c32bef95a4d7a8"},
+ {file = "tomli-2.4.1-cp314-cp314t-win_amd64.whl", hash = "sha256:2c1c351919aca02858f740c6d33adea0c5deea37f9ecca1cc1ef9e884a619d26"},
+ {file = "tomli-2.4.1-cp314-cp314t-win_arm64.whl", hash = "sha256:eab21f45c7f66c13f2a9e0e1535309cee140182a9cdae1e041d02e47291e8396"},
+ {file = "tomli-2.4.1-py3-none-any.whl", hash = "sha256:0d85819802132122da43cb86656f8d1f8c6587d54ae7dcaf30e90533028b49fe"},
+ {file = "tomli-2.4.1.tar.gz", hash = "sha256:7c7e1a961a0b2f2472c1ac5b69affa0ae1132c39adcb67aba98568702b9cc23f"},
]
[[package]]
diff --git a/pyproject.toml b/pyproject.toml
index c0e22abf..795b03a5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ dynamic = ["version"]
[tool.poetry]
name = "vital"
-version = "2.1.569"
+version = "3.0.0"
description = ""
readme = "README.md"
authors = []
@@ -19,6 +19,9 @@ classifiers = [
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
+ "Programming Language :: Python :: 3.13",
+ "Programming Language :: Python :: 3.14",
+ "Programming Language :: Python :: 3.15",
"Operating System :: OS Independent",
"Operating System :: POSIX",
"Operating System :: MacOS",
diff --git a/reference.md b/reference.md
deleted file mode 100644
index 5cd24c71..00000000
--- a/reference.md
+++ /dev/null
@@ -1,17552 +0,0 @@
-# Reference
-## Link
-client.link.list_bulk_ops(...) -> AsyncHttpResponse[BulkOpsResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-from vital.link import LinkListBulkOpsRequestTeamId
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.list_bulk_ops(
- next_cursor="next_cursor",
- page_size=1,
- team_id=LinkListBulkOpsRequestTeamId.INFER_FROM_CONTEXT,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**next_cursor:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**team_id:** `typing.Optional[LinkListBulkOpsRequestTeamId]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.bulk_import(...) -> AsyncHttpResponse[BulkImportConnectionsResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import ConnectionRecipe, OAuthProviders, Vital
-from vital.link import LinkBulkImportRequestTeamId
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.bulk_import(
- team_id=LinkBulkImportRequestTeamId.INFER_FROM_CONTEXT,
- provider=OAuthProviders.OURA,
- connections=[
- ConnectionRecipe(
- user_id="user_id",
- access_token="access_token",
- refresh_token="refresh_token",
- provider_id="provider_id",
- expires_at=1,
- )
- ],
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**provider:** `OAuthProviders`
-
-
-
-
-
--
-
-**connections:** `typing.Sequence[ConnectionRecipe]`
-
-
-
-
-
--
-
-**team_id:** `typing.Optional[LinkBulkImportRequestTeamId]`
-
-
-
-
-
--
-
-**wait_for_completion:** `typing.Optional[bool]`
-
-
-Whether or not the endpoint should wait for the Bulk Op to complete before responding.
-
-When `wait_for_completion` is enabled, the endpoint may respond 200 OK if the Bulk Op takes less than 20 seconds to complete.
-
-Otherwise, the endpoint always responds with 202 Created once the submitted data have been enqueued successfully. You can use
-the [List Bulk Ops](https://docs.tryvital.io/api-reference/link/list-bulk-ops) endpoint to inspect the progress of the Bulk Op.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.bulk_trigger_historical_pull(...) -> AsyncHttpResponse[typing.Any]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import OAuthProviders, Vital
-from vital.link import LinkBulkTriggerHistoricalPullRequestTeamId
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.bulk_trigger_historical_pull(
- team_id=LinkBulkTriggerHistoricalPullRequestTeamId.INFER_FROM_CONTEXT,
- user_ids=["user_ids"],
- provider=OAuthProviders.OURA,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_ids:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**provider:** `OAuthProviders`
-
-
-
-
-
--
-
-**team_id:** `typing.Optional[LinkBulkTriggerHistoricalPullRequestTeamId]`
-
-
-
-
-
--
-
-**wait_for_completion:** `typing.Optional[bool]`
-
-
-Whether or not the endpoint should wait for the Bulk Op to complete before responding.
-
-When `wait_for_completion` is enabled, the endpoint may respond 200 OK if the Bulk Op takes less than 20 seconds to complete.
-
-Otherwise, the endpoint always responds with 202 Created once the submitted data have been enqueued successfully. You can use
-the [List Bulk Ops](https://docs.tryvital.io/api-reference/link/list-bulk-ops) endpoint to inspect the progress of the Bulk Op.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.bulk_export(...) -> AsyncHttpResponse[BulkExportConnectionsResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import OAuthProviders, Vital
-from vital.link import LinkBulkExportRequestTeamId
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.bulk_export(
- team_id=LinkBulkExportRequestTeamId.INFER_FROM_CONTEXT,
- provider=OAuthProviders.OURA,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**provider:** `OAuthProviders`
-
-
-
-
-
--
-
-**team_id:** `typing.Optional[LinkBulkExportRequestTeamId]`
-
-
-
-
-
--
-
-**user_ids:** `typing.Optional[typing.Sequence[str]]`
-
-
-
-
-
--
-
-**next_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.bulk_pause(...) -> AsyncHttpResponse[typing.Any]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import OAuthProviders, Vital
-from vital.link import LinkBulkPauseRequestTeamId
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.bulk_pause(
- team_id=LinkBulkPauseRequestTeamId.INFER_FROM_CONTEXT,
- user_ids=["user_ids"],
- provider=OAuthProviders.OURA,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_ids:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**provider:** `OAuthProviders`
-
-
-
-
-
--
-
-**team_id:** `typing.Optional[LinkBulkPauseRequestTeamId]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.token(...) -> AsyncHttpResponse[LinkTokenExchangeResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Endpoint to generate a user link token, to be used throughout the vital
-link process. The vital link token is a one time use token, that
-expires after 10 minutes. If you would like vital-link widget to launch
-with a specific provider, pass in a provider in the body. If you would
-like to redirect to a custom url after successful or error connection,
-pass in your own custom redirect_url parameter.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.token(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str` â User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[Providers]`
-
-
-
-
-
--
-
-**redirect_url:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**filter_on_providers:** `typing.Optional[typing.Sequence[Providers]]`
-
-An allowlist of providers dictating what Vital Link Widget should show to the end user.
-If unspecified, all linkable providers are shown.
-
-This has no effect on programmatic Vital Link API usage.
-
-
-
-
-
--
-
-**on_error:** `typing.Optional[typing.Literal["redirect"]]`
-
-By default, Vital Link Widget input forms for password and email providers have in-built error handling.
-
-Specifying `on_error=redirect` disables this Vital Link Widget UI behaviour â it would
-instead redirect to your `redirect_url`, with Link Error parameters injected.
-
-This has no effect on OAuth providers â they always redirect to your `redirect_url`. This also has
-no effect on programmatic Vital Link API usage.
-
-
-
-
-
--
-
-**on_close:** `typing.Optional[typing.Literal["redirect"]]`
-
-By default, Vital Link Widget closes the window or tab when the user taps the Close button.
-
-Specifying `on_close=redirect` would change the Close button behaviour to redirect to your `redirect_url`
-with the `user_cancelled` error specified.
-
-This has no effect on programmatic Vital Link API usage.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.is_token_valid(...) -> AsyncHttpResponse[typing.Dict[str, typing.Any]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.is_token_valid(
- token="token",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**token:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.code_create(...) -> AsyncHttpResponse[VitalTokenCreatedResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Generate a token to invite a user of Vital mobile app to your team
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.code_create(
- user_id="user_id",
- expires_at=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**expires_at:** `typing.Optional[dt.datetime]` â When the link code should expire. Defaults to server time plus 1 hour.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.start_connect(...) -> AsyncHttpResponse[typing.Dict[str, typing.Any]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-REQUEST_SOURCE: VITAL-LINK
-Start link token process
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Providers, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.start_connect(
- link_token="link_token",
- provider=Providers.OURA,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**link_token:** `str`
-
-
-
-
-
--
-
-**provider:** `Providers`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.token_state(...) -> AsyncHttpResponse[typing.Dict[str, typing.Any]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-REQUEST_SOURCE: VITAL-LINK
-Check link token state - can be hit continuously used as heartbeat
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.token_state(
- vital_link_token="x-vital-link-token",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.email_auth(...) -> AsyncHttpResponse[typing.Any]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AuthType, Providers, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.email_auth(
- vital_link_token="x-vital-link-token",
- email="email",
- provider=Providers.OURA,
- auth_type=AuthType.PASSWORD,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**email:** `str`
-
-
-
-
-
--
-
-**provider:** `Providers`
-
-
-
-
-
--
-
-**auth_type:** `AuthType`
-
-
-
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**region:** `typing.Optional[Region]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.password_auth(...) -> AsyncHttpResponse[typing.Any]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AuthType, Providers, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.password_auth(
- vital_link_token="x-vital-link-token",
- username="username",
- password="password",
- provider=Providers.OURA,
- auth_type=AuthType.PASSWORD,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**username:** `str`
-
-
-
-
-
--
-
-**password:** `str`
-
-
-
-
-
--
-
-**provider:** `Providers`
-
-
-
-
-
--
-
-**auth_type:** `AuthType`
-
-
-
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.generate_oauth_link(...) -> AsyncHttpResponse[Source]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-This endpoint generates an OAuth link for oauth provider
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import OAuthProviders, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.generate_oauth_link(
- oauth_provider=OAuthProviders.OURA,
- vital_link_token="x-vital-link-token",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**oauth_provider:** `OAuthProviders`
-
-
-
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.connect_password_provider(...) -> AsyncHttpResponse[ProviderLinkResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-This connects auth providers that are password based.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import PasswordProviders, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.connect_password_provider(
- provider=PasswordProviders.WHOOP,
- vital_link_token="x-vital-link-token",
- username="username",
- password="password",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**provider:** `PasswordProviders`
-
-
-
-
-
--
-
-**username:** `str` â Username for provider
-
-
-
-
-
--
-
-**password:** `str` â Password for provider
-
-
-
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**region:** `typing.Optional[Region]` â Provider region to authenticate against. Only applicable to specific providers.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.complete_password_provider_mfa(...) -> AsyncHttpResponse[ProviderLinkResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-This connects auth providers that are password based.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import PasswordProviders, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.complete_password_provider_mfa(
- provider=PasswordProviders.WHOOP,
- vital_link_token="x-vital-link-token",
- mfa_code="mfa_code",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**provider:** `PasswordProviders`
-
-
-
-
-
--
-
-**mfa_code:** `str`
-
-
-
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.connect_email_auth_provider(...) -> AsyncHttpResponse[typing.Any]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-This connects auth providers that are email based.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.connect_email_auth_provider(
- vital_link_token="x-vital-link-token",
- email="email",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**email:** `str`
-
-
-
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**email_provider_auth_link_provider:** `typing.Optional[Providers]`
-
-
-
-
-
--
-
-**region:** `typing.Optional[Region]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.get_all_providers(...) -> AsyncHttpResponse[typing.List[SourceLink]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET List of all available providers given the generated link token.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.get_all_providers(
- vital_link_token="x-vital-link-token",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.connect_manual_provider(...) -> AsyncHttpResponse[typing.Dict[str, bool]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import ManualProviders, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.connect_manual_provider(
- provider=ManualProviders.BEURER_BLE,
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**provider:** `ManualProviders`
-
-
-
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**provider_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.link.connect_demo_provider(...) -> AsyncHttpResponse[DemoConnectionStatus]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-POST Connect the given Vital user to a demo provider.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import DemoProviders, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.link.connect_demo_provider(
- user_id="user_id",
- provider=DemoProviders.APPLE_HEALTH_KIT,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str` â Vital user ID
-
-
-
-
-
--
-
-**provider:** `DemoProviders` â Demo provider. For more information, please check out our docs (https://docs.tryvital.io/wearables/providers/test_data)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.electrocardiogram.get(...) -> AsyncHttpResponse[ClientFacingElectrocardiogramResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get electrocardiogram summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.electrocardiogram.get(
- user_id="user_id",
- start_date="start_date",
- end_date="end_date",
- provider="provider",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str`
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.sleep_cycle.get(...) -> AsyncHttpResponse[ClientSleepCycleResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get sleep cycle for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.sleep_cycle.get(
- user_id="user_id",
- start_date="start_date",
- end_date="end_date",
- provider="provider",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str`
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.profile.get(...) -> AsyncHttpResponse[ClientFacingProfile]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get profile for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.profile.get(
- user_id="user_id",
- provider="provider",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.profile.get_raw(...) -> AsyncHttpResponse[RawProfile]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get raw profile for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.profile.get_raw(
- user_id="user_id",
- provider="provider",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.devices.get_raw(...) -> AsyncHttpResponse[RawDevices]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get Devices for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.devices.get_raw(
- user_id="user_id",
- provider="provider",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.activity.get(...) -> AsyncHttpResponse[ClientActivityResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get activity summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.activity.get(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.activity.get_raw(...) -> AsyncHttpResponse[RawActivity]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get raw activity summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.activity.get_raw(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workouts.get(...) -> AsyncHttpResponse[ClientWorkoutResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get workout summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.workouts.get(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workouts.get_raw(...) -> AsyncHttpResponse[RawWorkout]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get raw workout summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.workouts.get_raw(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workouts.get_by_workout_id(...) -> AsyncHttpResponse[ClientFacingStream]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.workouts.get_by_workout_id(
- workout_id="workout_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**workout_id:** `str` â The Vital ID for the workout
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.sleep.get(...) -> AsyncHttpResponse[ClientSleepResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get sleep summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.sleep.get(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.sleep.get_raw(...) -> AsyncHttpResponse[RawSleep]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get raw sleep summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.sleep.get_raw(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.sleep.get_stream_by_sleep_id(...) -> AsyncHttpResponse[ClientFacingSleepStream]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get Sleep stream for a user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.sleep.get_stream_by_sleep_id(
- sleep_id="sleep_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**sleep_id:** `str` â The Vital Sleep ID
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.body.get(...) -> AsyncHttpResponse[ClientBodyResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get Body summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.body.get(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.body.get_raw(...) -> AsyncHttpResponse[RawBody]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get raw Body summary for user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.body.get_raw(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.meal.get(...) -> AsyncHttpResponse[ClientFacingMealResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get user's meals
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.meal.get(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.menstrual_cycle.get(...) -> AsyncHttpResponse[MenstrualCycleResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.menstrual_cycle.get(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.workout_swimming_stroke_grouped(...) -> AsyncHttpResponse[GroupedWorkoutSwimmingStrokeResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.workout_swimming_stroke_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.workout_distance_grouped(...) -> AsyncHttpResponse[GroupedWorkoutDistanceResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.workout_distance_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.heart_rate_recovery_one_minute_grouped(...) -> AsyncHttpResponse[GroupedHeartRateRecoveryOneMinuteResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.heart_rate_recovery_one_minute_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.waist_circumference_grouped(...) -> AsyncHttpResponse[GroupedWaistCircumferenceResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.waist_circumference_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.lean_body_mass_grouped(...) -> AsyncHttpResponse[GroupedLeanBodyMassResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.lean_body_mass_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_mass_index_grouped(...) -> AsyncHttpResponse[GroupedBodyMassIndexResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_mass_index_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.basal_body_temperature_grouped(...) -> AsyncHttpResponse[GroupedBasalBodyTemperatureResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.basal_body_temperature_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.handwashing_grouped(...) -> AsyncHttpResponse[GroupedHandwashingResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.handwashing_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.daylight_exposure_grouped(...) -> AsyncHttpResponse[GroupedDaylightExposureResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.daylight_exposure_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.uv_exposure_grouped(...) -> AsyncHttpResponse[GroupedUvExposureResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.uv_exposure_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.fall_grouped(...) -> AsyncHttpResponse[GroupedFallResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.fall_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.inhaler_usage_grouped(...) -> AsyncHttpResponse[GroupedInhalerUsageResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.inhaler_usage_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.peak_expiratory_flow_rate_grouped(...) -> AsyncHttpResponse[GroupedPeakExpiratoryFlowRateResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.peak_expiratory_flow_rate_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.forced_vital_capacity_grouped(...) -> AsyncHttpResponse[GroupedForcedVitalCapacityResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.forced_vital_capacity_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.forced_expiratory_volume_1_grouped(...) -> AsyncHttpResponse[GroupedForcedExpiratoryVolume1Response]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.forced_expiratory_volume_1_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.wheelchair_push_grouped(...) -> AsyncHttpResponse[GroupedWheelchairPushResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.wheelchair_push_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.sleep_breathing_disturbance_grouped(...) -> AsyncHttpResponse[GroupedSleepBreathingDisturbanceResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.sleep_breathing_disturbance_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.sleep_apnea_alert_grouped(...) -> AsyncHttpResponse[GroupedSleepApneaAlertResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.sleep_apnea_alert_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.stand_duration_grouped(...) -> AsyncHttpResponse[GroupedStandDurationResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.stand_duration_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.stand_hour_grouped(...) -> AsyncHttpResponse[GroupedStandHourResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.stand_hour_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.heart_rate_alert_grouped(...) -> AsyncHttpResponse[GroupedHeartRateAlertResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.heart_rate_alert_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.afib_burden_grouped(...) -> AsyncHttpResponse[GroupedAFibBurdenResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.afib_burden_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.workout_duration_grouped(...) -> AsyncHttpResponse[GroupedWorkoutDurationResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.workout_duration_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.vo_2_max_grouped(...) -> AsyncHttpResponse[GroupedVo2MaxResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.vo_2_max_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.stress_level_grouped(...) -> AsyncHttpResponse[GroupedStressLevelResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.stress_level_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.mindfulness_minutes_grouped(...) -> AsyncHttpResponse[GroupedMindfulnessMinutesResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.mindfulness_minutes_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.caffeine_grouped(...) -> AsyncHttpResponse[GroupedCaffeineResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.caffeine_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.water_grouped(...) -> AsyncHttpResponse[GroupedWaterResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.water_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.steps_grouped(...) -> AsyncHttpResponse[GroupedStepsResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.steps_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.floors_climbed_grouped(...) -> AsyncHttpResponse[GroupedFloorsClimbedResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.floors_climbed_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.distance_grouped(...) -> AsyncHttpResponse[GroupedDistanceResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.distance_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.calories_basal_grouped(...) -> AsyncHttpResponse[GroupedCaloriesBasalResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.calories_basal_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.calories_active_grouped(...) -> AsyncHttpResponse[GroupedCaloriesActiveResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.calories_active_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.respiratory_rate_grouped(...) -> AsyncHttpResponse[GroupedRespiratoryRateResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.respiratory_rate_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.note_grouped(...) -> AsyncHttpResponse[GroupedNoteResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.note_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.insulin_injection_grouped(...) -> AsyncHttpResponse[GroupedInsulinInjectionResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.insulin_injection_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.ige_grouped(...) -> AsyncHttpResponse[GroupedIgeResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.ige_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.igg_grouped(...) -> AsyncHttpResponse[GroupedIggResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.igg_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.hypnogram_grouped(...) -> AsyncHttpResponse[GroupedHypnogramResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.hypnogram_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.hrv_grouped(...) -> AsyncHttpResponse[GroupedHrvResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.hrv_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.heartrate_grouped(...) -> AsyncHttpResponse[GroupedHeartRateResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.heartrate_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.glucose_grouped(...) -> AsyncHttpResponse[GroupedGlucoseResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.glucose_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.cholesterol_grouped(...) -> AsyncHttpResponse[GroupedCholesterolResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.cholesterol_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.carbohydrates_grouped(...) -> AsyncHttpResponse[GroupedCarbohydratesResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.carbohydrates_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_temperature_delta_grouped(...) -> AsyncHttpResponse[GroupedBodyTemperatureDeltaResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_temperature_delta_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_temperature_grouped(...) -> AsyncHttpResponse[GroupedBodyTemperatureResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_temperature_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_weight_grouped(...) -> AsyncHttpResponse[GroupedBodyWeightResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_weight_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_fat_grouped(...) -> AsyncHttpResponse[GroupedBodyFatResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_fat_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.blood_oxygen_grouped(...) -> AsyncHttpResponse[GroupedBloodOxygenResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.blood_oxygen_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.electrocardiogram_voltage_grouped(...) -> AsyncHttpResponse[GroupedElectrocardiogramVoltageResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.electrocardiogram_voltage_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.blood_pressure_grouped(...) -> AsyncHttpResponse[GroupedBloodPressureResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.blood_pressure_grouped(
- user_id="user_id",
- cursor="cursor",
- next_cursor="next_cursor",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.vo_2_max(...) -> AsyncHttpResponse[typing.List[ClientFacingVo2MaxTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.vo_2_max(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.stress_level(...) -> AsyncHttpResponse[typing.List[ClientFacingStressLevelTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.stress_level(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.mindfulness_minutes(...) -> AsyncHttpResponse[typing.List[ClientFacingMindfulnessMinutesTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.mindfulness_minutes(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.caffeine(...) -> AsyncHttpResponse[typing.List[ClientFacingCaffeineTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.caffeine(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.water(...) -> AsyncHttpResponse[typing.List[ClientFacingWaterTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.water(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.steps(...) -> AsyncHttpResponse[typing.List[ClientFacingStepsTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.steps(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.floors_climbed(...) -> AsyncHttpResponse[typing.List[ClientFacingFloorsClimbedTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.floors_climbed(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.distance(...) -> AsyncHttpResponse[typing.List[ClientFacingDistanceTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.distance(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.calories_basal(...) -> AsyncHttpResponse[typing.List[ClientFacingCaloriesBasalTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.calories_basal(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.calories_active(...) -> AsyncHttpResponse[typing.List[ClientFacingCaloriesActiveTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.calories_active(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.respiratory_rate(...) -> AsyncHttpResponse[typing.List[ClientFacingRespiratoryRateTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.respiratory_rate(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.ige(...) -> AsyncHttpResponse[typing.List[ClientFacingIgeTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.ige(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.igg(...) -> AsyncHttpResponse[typing.List[ClientFacingIggTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.igg(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.hypnogram(...) -> AsyncHttpResponse[typing.List[ClientFacingHypnogramTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.hypnogram(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.hrv(...) -> AsyncHttpResponse[typing.List[ClientFacingHrvTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.hrv(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.heartrate(...) -> AsyncHttpResponse[typing.List[ClientFacingHeartRateTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.heartrate(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.glucose(...) -> AsyncHttpResponse[typing.List[ClientFacingGlucoseTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.glucose(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.cholesterol_triglycerides(...) -> AsyncHttpResponse[typing.List[ClientFacingCholesterolTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.cholesterol_triglycerides(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.cholesterol_total(...) -> AsyncHttpResponse[typing.List[ClientFacingCholesterolTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.cholesterol_total(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.cholesterol_ldl(...) -> AsyncHttpResponse[typing.List[ClientFacingCholesterolTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.cholesterol_ldl(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.cholesterol_hdl(...) -> AsyncHttpResponse[typing.List[ClientFacingCholesterolTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.cholesterol_hdl(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.cholesterol(...) -> AsyncHttpResponse[typing.List[ClientFacingCholesterolTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.cholesterol(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_weight(...) -> AsyncHttpResponse[typing.List[ClientFacingBodyWeightTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_weight(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.body_fat(...) -> AsyncHttpResponse[typing.List[ClientFacingBodyFatTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.body_fat(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.blood_oxygen(...) -> AsyncHttpResponse[typing.List[ClientFacingBloodOxygenTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.blood_oxygen(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.electrocardiogram_voltage(...) -> AsyncHttpResponse[typing.List[ClientFacingElectrocardiogramVoltageTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.electrocardiogram_voltage(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.vitals.blood_pressure(...) -> AsyncHttpResponse[typing.List[ClientFacingBloodPressureTimeseries]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.vitals.blood_pressure(
- user_id="user_id",
- provider="provider",
- start_date="start_date",
- end_date="end_date",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**start_date:** `str` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**provider:** `typing.Optional[str]` â Provider oura/strava etc
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_all(...) -> AsyncHttpResponse[PaginatedUsersResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET All users for team.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_all(
- offset=1,
- limit=1,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**offset:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.create(...) -> AsyncHttpResponse[ClientFacingUserKey]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-POST Create a Vital user given a client_user_id and returns the user_id.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.create(
- client_user_id="client_user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**client_user_id:** `str` â A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
-
-
-
-
-
--
-
-**fallback_time_zone:** `typing.Optional[str]`
-
-
- Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
- Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
-
-
-
-
-
-
--
-
-**fallback_birth_date:** `typing.Optional[str]` â Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age.
-
-
-
-
-
--
-
-**ingestion_start:** `typing.Optional[str]` â Starting bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds).
-
-
-
-
-
--
-
-**ingestion_end:** `typing.Optional[str]` â Ending bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_team_metrics() -> AsyncHttpResponse[MetricsResult]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET metrics for team.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_team_metrics()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_connected_providers(...) -> AsyncHttpResponse[typing.Dict[str, typing.List[ClientFacingProviderWithStatus]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET Users connected providers
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_connected_providers(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_latest_user_info(...) -> AsyncHttpResponse[UserInfo]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_latest_user_info(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.create_insurance(...) -> AsyncHttpResponse[ClientFacingInsurance]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- Address,
- Gender,
- ResponsibleRelationship,
- Vital,
- VitalCoreSchemasDbSchemasLabTestInsurancePersonDetails,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.create_insurance(
- user_id="user_id",
- payor_code="payor_code",
- member_id="member_id",
- relationship=ResponsibleRelationship.SELF,
- insured=VitalCoreSchemasDbSchemasLabTestInsurancePersonDetails(
- first_name="first_name",
- last_name="last_name",
- gender=Gender.FEMALE,
- address=Address(
- first_line="first_line",
- country="country",
- zip="zip",
- city="city",
- state="state",
- ),
- dob="dob",
- email="email",
- phone_number="phone_number",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**payor_code:** `str`
-
-
-
-
-
--
-
-**member_id:** `str`
-
-
-
-
-
--
-
-**relationship:** `ResponsibleRelationship`
-
-
-
-
-
--
-
-**insured:** `VitalCoreSchemasDbSchemasLabTestInsurancePersonDetails`
-
-
-
-
-
--
-
-**group_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**guarantor:** `typing.Optional[GuarantorDetails]`
-
-
-
-
-
--
-
-**is_primary:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_latest_insurance(...) -> AsyncHttpResponse[ClientFacingInsurance]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_latest_insurance(
- user_id="user_id",
- is_primary=True,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**is_primary:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.upsert_user_info(...) -> AsyncHttpResponse[UserInfo]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Address, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.upsert_user_info(
- user_id="user_id",
- first_name="first_name",
- last_name="last_name",
- email="email",
- phone_number="phone_number",
- gender="gender",
- dob="dob",
- address=Address(
- first_line="first_line",
- country="country",
- zip="zip",
- city="city",
- state="state",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**first_name:** `str`
-
-
-
-
-
--
-
-**last_name:** `str`
-
-
-
-
-
--
-
-**email:** `str`
-
-
-
-
-
--
-
-**phone_number:** `str`
-
-
-
-
-
--
-
-**gender:** `str`
-
-
-
-
-
--
-
-**dob:** `str`
-
-
-
-
-
--
-
-**address:** `Address`
-
-
-
-
-
--
-
-**medical_proxy:** `typing.Optional[GuarantorDetails]`
-
-
-
-
-
--
-
-**race:** `typing.Optional[Race]`
-
-
-
-
-
--
-
-**ethnicity:** `typing.Optional[Ethnicity]`
-
-
-
-
-
--
-
-**sexual_orientation:** `typing.Optional[SexualOrientation]`
-
-
-
-
-
--
-
-**gender_identity:** `typing.Optional[GenderIdentity]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_by_client_user_id(...) -> AsyncHttpResponse[ClientFacingUser]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET user_id from client_user_id.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_by_client_user_id(
- client_user_id="client_user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**client_user_id:** `str` â A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.deregister_provider(...) -> AsyncHttpResponse[UserSuccessResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Providers, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.deregister_provider(
- user_id="user_id",
- provider=Providers.OURA,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**provider:** `Providers` â Provider slug. e.g., `oura`, `fitbit`, `garmin`.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get(...) -> AsyncHttpResponse[ClientFacingUser]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.delete(...) -> AsyncHttpResponse[UserSuccessResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.delete(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.patch(...) -> AsyncHttpResponse[None]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.patch(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**fallback_time_zone:** `typing.Optional[str]`
-
-
- Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
- Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
-
-
-
-
-
-
--
-
-**fallback_birth_date:** `typing.Optional[str]` â Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age.
-
-
-
-
-
--
-
-**ingestion_start:** `typing.Optional[str]` â Starting bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds).
-
-
-
-
-
--
-
-**ingestion_end:** `typing.Optional[str]` â Ending bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds).
-
-
-
-
-
--
-
-**client_user_id:** `typing.Optional[str]` â A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.undo_delete(...) -> AsyncHttpResponse[UserSuccessResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.undo_delete(
- user_id="user_id",
- client_user_id="client_user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `typing.Optional[str]` â User ID to undo deletion. Mutually exclusive with `client_user_id`.
-
-
-
-
-
--
-
-**client_user_id:** `typing.Optional[str]` â Client User ID to undo deletion. Mutually exclusive with `user_id`.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.refresh(...) -> AsyncHttpResponse[UserRefreshSuccessResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Trigger a manual refresh for a specific user
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.refresh(
- user_id="user_id",
- timeout=1.1,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**timeout:** `typing.Optional[float]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_devices(...) -> AsyncHttpResponse[typing.List[ClientFacingDevice]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_devices(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_device(...) -> AsyncHttpResponse[ClientFacingDevice]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_device(
- user_id="user_id",
- device_id="device_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**device_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.get_user_sign_in_token(...) -> AsyncHttpResponse[UserSignInTokenResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.get_user_sign_in_token(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.user.create_portal_url(...) -> AsyncHttpResponse[CreateUserPortalUrlResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-from vital.user import CreateUserPortalUrlBodyContext
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.user.create_portal_url(
- user_id="user_id",
- context=CreateUserPortalUrlBodyContext.LAUNCH,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**context:** `CreateUserPortalUrlBodyContext`
-
-`launch`: Generates a short-lived (minutes) portal URL that is intended for launching a user from your
-authenticated web context directly into the Junction User Portal. This URL is not suitable for asynchronous
-communications due to its verbosity as well as short-lived nature.
-
-`communications`: Generates a long-lived (weeks) but shortened portal URL that is suitable for Emails, SMS
-messages and other communication channels. Users may be asked to verify their identity with Email and SMS
-authentication, e.g., when they open a short link on a new device. âšī¸ This enum is non-exhaustive.
-
-
-
-
-
--
-
-**order_id:** `typing.Optional[str]` â If specified, the generated URL will deeplink to the specified Order.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.get_link_config(...) -> AsyncHttpResponse[typing.Dict[str, typing.Any]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Post teams.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.get_link_config(
- vital_link_token="x-vital-link-token",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**vital_link_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.get(...) -> AsyncHttpResponse[ClientFacingTeam]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get team.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.get(
- team_id="team_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**team_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.get_user_by_id(...) -> AsyncHttpResponse[typing.List[ClientFacingUser]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Search team users by user_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.get_user_by_id(
- query_id="query_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**query_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.get_svix_url() -> AsyncHttpResponse[typing.Dict[str, typing.Any]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.get_svix_url()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.get_source_priorities(...) -> AsyncHttpResponse[typing.List[typing.Dict[str, typing.Any]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET source priorities.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import PriorityResource, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.get_source_priorities(
- data_type=PriorityResource.WORKOUTS,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**data_type:** `typing.Optional[PriorityResource]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.update_source_priorities() -> AsyncHttpResponse[typing.List[typing.Dict[str, typing.Any]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Patch source priorities.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.update_source_priorities()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.team.get_physicians(...) -> AsyncHttpResponse[typing.List[ClientFacingPhysician]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.team.get_physicians(
- team_id="team_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**team_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.providers.get_all(...) -> AsyncHttpResponse[typing.List[ClientFacingProviderDetailed]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get Provider list
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.providers.get_all(
- source_type="source_type",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**source_type:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.introspect.get_user_resources(...) -> AsyncHttpResponse[UserResourcesResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Providers, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.introspect.get_user_resources(
- user_id="user_id",
- provider=Providers.OURA,
- user_limit=1,
- cursor="cursor",
- next_cursor="next_cursor",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `typing.Optional[str]` â Filter by user ID.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[Providers]`
-
-
-
-
-
--
-
-**user_limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.introspect.get_user_historical_pulls(...) -> AsyncHttpResponse[UserHistoricalPullsResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Providers, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.introspect.get_user_historical_pulls(
- user_id="user_id",
- provider=Providers.OURA,
- user_limit=1,
- cursor="cursor",
- next_cursor="next_cursor",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `typing.Optional[str]` â Filter by user ID.
-
-
-
-
-
--
-
-**provider:** `typing.Optional[Providers]`
-
-
-
-
-
--
-
-**user_limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]` â The cursor for fetching the next page, or `null` to fetch the first page.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get(...) -> AsyncHttpResponse[typing.List[ClientFacingLabTest]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET all the lab tests the team has access to.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- LabTestCollectionMethod,
- LabTestGenerationMethodFilter,
- LabTestStatus,
- Vital,
-)
-from vital.lab_tests import (
- LabTestsGetRequestOrderDirection,
- LabTestsGetRequestOrderKey,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get(
- generation_method=LabTestGenerationMethodFilter.AUTO,
- lab_slug="lab_slug",
- collection_method=LabTestCollectionMethod.TESTKIT,
- status=LabTestStatus.ACTIVE,
- name="name",
- order_key=LabTestsGetRequestOrderKey.PRICE,
- order_direction=LabTestsGetRequestOrderDirection.ASC,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**generation_method:** `typing.Optional[LabTestGenerationMethodFilter]` â Filter on whether auto-generated lab tests created by Vital, manually created lab tests, or all lab tests should be returned.
-
-
-
-
-
--
-
-**lab_slug:** `typing.Optional[str]` â Filter by the slug of the lab for these lab tests.
-
-
-
-
-
--
-
-**collection_method:** `typing.Optional[LabTestCollectionMethod]` â Filter by the collection method for these lab tests.
-
-
-
-
-
--
-
-**status:** `typing.Optional[LabTestStatus]` â Filter by the status of these lab tests.
-
-
-
-
-
--
-
-**marker_ids:** `typing.Optional[typing.Union[int, typing.Sequence[int]]]` â Filter to only include lab tests containing these marker IDs.
-
-
-
-
-
--
-
-**provider_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` â Filter to only include lab tests containing these provider IDs.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` â Filter by the name of the lab test (a case-insensitive substring search).
-
-
-
-
-
--
-
-**order_key:** `typing.Optional[LabTestsGetRequestOrderKey]`
-
-
-
-
-
--
-
-**order_direction:** `typing.Optional[LabTestsGetRequestOrderDirection]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.create(...) -> AsyncHttpResponse[ClientFacingLabTest]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import LabTestCollectionMethod, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.create(
- name="name",
- method=LabTestCollectionMethod.TESTKIT,
- description="description",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**method:** `LabTestCollectionMethod`
-
-
-
-
-
--
-
-**description:** `str`
-
-
-
-
-
--
-
-**marker_ids:** `typing.Optional[typing.Sequence[int]]`
-
-
-
-
-
--
-
-**provider_ids:** `typing.Optional[typing.Sequence[str]]`
-
-
-
-
-
--
-
-**fasting:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_by_id(...) -> AsyncHttpResponse[ClientFacingLabTest]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET all the lab tests the team has access to.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_by_id(
- lab_test_id="lab_test_id",
- lab_account_id="lab_account_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**lab_test_id:** `str`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]` â The lab account ID. This lab account is used to determine the availability of markers and lab tests.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.update_lab_test(...) -> AsyncHttpResponse[ClientFacingLabTest]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.update_lab_test(
- lab_test_id="lab_test_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**lab_test_id:** `str`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**active:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_markers(...) -> AsyncHttpResponse[GetMarkersResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET all the markers for the given lab.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_markers(
- name="name",
- a_la_carte_enabled=True,
- lab_account_id="lab_account_id",
- page=1,
- size=1,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**lab_id:** `typing.Optional[typing.Union[int, typing.Sequence[int]]]` â The identifier Vital assigned to a lab partner.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` â The name or test code of an individual biomarker or a panel.
-
-
-
-
-
--
-
-**a_la_carte_enabled:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]` â The lab account ID. This lab account is used to determine the availability of markers and lab tests.
-
-
-
-
-
--
-
-**page:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**size:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_markers_for_order_set(...) -> AsyncHttpResponse[GetMarkersResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import OrderSetRequest, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_markers_for_order_set(
- page=1,
- size=1,
- request=OrderSetRequest(),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request:** `OrderSetRequest`
-
-
-
-
-
--
-
-**page:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**size:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_markers_for_lab_test(...) -> AsyncHttpResponse[GetMarkersResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_markers_for_lab_test(
- lab_test_id="lab_test_id",
- lab_account_id="lab_account_id",
- page=1,
- size=1,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**lab_test_id:** `str`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]` â The lab account ID. This lab account is used to determine the availability of markers and lab tests.
-
-
-
-
-
--
-
-**page:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**size:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_markers_by_lab_and_provider_id(...) -> AsyncHttpResponse[ClientFacingMarker]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET a specific marker for the given lab and provider_id
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_markers_by_lab_and_provider_id(
- provider_id="provider_id",
- lab_id=1,
- lab_account_id="lab_account_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**provider_id:** `str`
-
-
-
-
-
--
-
-**lab_id:** `int`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]` â The lab account ID. This lab account is used to determine the availability of markers and lab tests.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_labs() -> AsyncHttpResponse[typing.List[ClientFacingLab]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET all the labs.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_labs()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_paginated(...) -> AsyncHttpResponse[LabTestResourcesResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET lab tests the team has access to as a paginated list.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- LabTestCollectionMethod,
- LabTestGenerationMethodFilter,
- LabTestStatus,
- Vital,
-)
-from vital.lab_tests import (
- LabTestsGetPaginatedRequestOrderDirection,
- LabTestsGetPaginatedRequestOrderKey,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_paginated(
- lab_test_limit=1,
- next_cursor="next_cursor",
- generation_method=LabTestGenerationMethodFilter.AUTO,
- lab_slug="lab_slug",
- collection_method=LabTestCollectionMethod.TESTKIT,
- status=LabTestStatus.ACTIVE,
- name="name",
- order_key=LabTestsGetPaginatedRequestOrderKey.PRICE,
- order_direction=LabTestsGetPaginatedRequestOrderDirection.ASC,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**lab_test_limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**generation_method:** `typing.Optional[LabTestGenerationMethodFilter]` â Filter on whether auto-generated lab tests created by Vital, manually created lab tests, or all lab tests should be returned.
-
-
-
-
-
--
-
-**lab_slug:** `typing.Optional[str]` â Filter by the slug of the lab for these lab tests.
-
-
-
-
-
--
-
-**collection_method:** `typing.Optional[LabTestCollectionMethod]` â Filter by the collection method for these lab tests.
-
-
-
-
-
--
-
-**status:** `typing.Optional[LabTestStatus]` â Filter by the status of these lab tests.
-
-
-
-
-
--
-
-**marker_ids:** `typing.Optional[typing.Union[int, typing.Sequence[int]]]` â Filter to only include lab tests containing these marker IDs.
-
-
-
-
-
--
-
-**provider_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` â Filter to only include lab tests containing these provider IDs.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` â Filter by the name of the lab test (a case-insensitive substring search).
-
-
-
-
-
--
-
-**order_key:** `typing.Optional[LabTestsGetPaginatedRequestOrderKey]`
-
-
-
-
-
--
-
-**order_direction:** `typing.Optional[LabTestsGetPaginatedRequestOrderDirection]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_lab_test_collection_instruction_pdf(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_lab_test_collection_instruction_pdf(
- lab_test_id="lab_test_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**lab_test_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_orders(...) -> AsyncHttpResponse[GetOrdersResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET many orders with filters.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from vital import Interpretation, Vital
-from vital.lab_tests import (
- LabTestsGetOrdersRequestOrderDirection,
- LabTestsGetOrdersRequestOrderKey,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_orders(
- search_input="search_input",
- start_date=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- end_date=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- updated_start_date=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- updated_end_date=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- order_key=LabTestsGetOrdersRequestOrderKey.CREATED_AT,
- order_direction=LabTestsGetOrdersRequestOrderDirection.ASC,
- is_critical=True,
- interpretation=Interpretation.NORMAL,
- user_id="user_id",
- patient_name="patient_name",
- shipping_recipient_name="shipping_recipient_name",
- page=1,
- size=1,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**search_input:** `typing.Optional[str]` â Search by order id, user id, patient name, shipping dob, or shipping recipient name.
-
-
-
-
-
--
-
-**start_date:** `typing.Optional[dt.datetime]` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[dt.datetime]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
-
-
-
-
-
--
-
-**updated_start_date:** `typing.Optional[dt.datetime]` â Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**updated_end_date:** `typing.Optional[dt.datetime]` â Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
-
-
-
-
-
--
-
-**status:** `typing.Optional[
- typing.Union[OrderLowLevelStatus, typing.Sequence[OrderLowLevelStatus]]
-]` â Filter by low level status.
-
-
-
-
-
--
-
-**order_key:** `typing.Optional[LabTestsGetOrdersRequestOrderKey]` â Order key to sort by.
-
-
-
-
-
--
-
-**order_direction:** `typing.Optional[LabTestsGetOrdersRequestOrderDirection]` â Order direction to sort by.
-
-
-
-
-
--
-
-**order_type:** `typing.Optional[
- typing.Union[
- LabTestCollectionMethod, typing.Sequence[LabTestCollectionMethod]
- ]
-]` â Filter by method used to perform the lab test.
-
-
-
-
-
--
-
-**is_critical:** `typing.Optional[bool]` â Filter by critical order status.
-
-
-
-
-
--
-
-**interpretation:** `typing.Optional[Interpretation]` â Filter by result interpretation of the lab test.
-
-
-
-
-
--
-
-**order_activation_types:** `typing.Optional[
- typing.Union[OrderActivationType, typing.Sequence[OrderActivationType]]
-]` â Filter by activation type.
-
-
-
-
-
--
-
-**user_id:** `typing.Optional[str]` â Filter by user ID.
-
-
-
-
-
--
-
-**patient_name:** `typing.Optional[str]` â Filter by patient name.
-
-
-
-
-
--
-
-**shipping_recipient_name:** `typing.Optional[str]` â Filter by shipping recipient name.
-
-
-
-
-
--
-
-**order_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` â Filter by order ids.
-
-
-
-
-
--
-
-**page:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**size:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_phlebotomy_appointment_availability(...) -> AsyncHttpResponse[AppointmentAvailabilitySlots]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Return the available time slots to book an appointment with a phlebotomist
-for the given address and order.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import UsAddress, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_phlebotomy_appointment_availability(
- start_date="start_date",
- request=UsAddress(
- first_line="first_line",
- city="city",
- state="state",
- zip_code="zip_code",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request:** `UsAddress`
-
-
-
-
-
--
-
-**start_date:** `typing.Optional[str]` â Start date for appointment availability
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.book_phlebotomy_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Book an at-home phlebotomy appointment.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AppointmentBookingRequest, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.book_phlebotomy_appointment(
- order_id="order_id",
- request=AppointmentBookingRequest(
- booking_key="booking_key",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request:** `AppointmentBookingRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.request_phlebotomy_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Request an at-home phlebotomy appointment.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AppointmentProvider, UsAddress, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.request_phlebotomy_appointment(
- order_id="order_id",
- address=UsAddress(
- first_line="first_line",
- city="city",
- state="state",
- zip_code="zip_code",
- ),
- provider=AppointmentProvider.GETLABS,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**address:** `UsAddress` â At-home phlebotomy appointment address.
-
-
-
-
-
--
-
-**provider:** `AppointmentProvider`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.reschedule_phlebotomy_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Reschedule a previously booked at-home phlebotomy appointment.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AppointmentRescheduleRequest, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.reschedule_phlebotomy_appointment(
- order_id="order_id",
- request=AppointmentRescheduleRequest(
- booking_key="booking_key",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request:** `AppointmentRescheduleRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.cancel_phlebotomy_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Cancel a previously booked at-home phlebotomy appointment.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.cancel_phlebotomy_appointment(
- order_id="order_id",
- cancellation_reason_id="cancellation_reason_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**cancellation_reason_id:** `str`
-
-
-
-
-
--
-
-**notes:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_phlebotomy_appointment_cancellation_reason() -> AsyncHttpResponse[typing.List[ClientFacingAppointmentCancellationReason]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get the list of reasons for cancelling an at-home phlebotomy appointment.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_phlebotomy_appointment_cancellation_reason()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_phlebotomy_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get the appointment associated with an order.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_phlebotomy_appointment(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_area_info(...) -> AsyncHttpResponse[AreaInfo]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET information about an area with respect to lab-testing.
-
-Information returned:
-* Whether a given zip code is served by our Phlebotomy network.
-* List of Lab locations in the area.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AllowedRadius, ClientFacingLabs, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_area_info(
- zip_code="zip_code",
- radius=AllowedRadius.TEN,
- lab=ClientFacingLabs.QUEST,
- lab_account_id="lab_account_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**zip_code:** `str` â Zip code of the area to check
-
-
-
-
-
--
-
-**radius:** `typing.Optional[AllowedRadius]` â Radius in which to search in miles
-
-
-
-
-
--
-
-**lab:** `typing.Optional[ClientFacingLabs]` â Lab to check for PSCs
-
-
-
-
-
--
-
-**labs:** `typing.Optional[
- typing.Union[ClientFacingLabs, typing.Sequence[ClientFacingLabs]]
-]` â List of labs to check for PSCs
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]` â Lab Account ID to use for availability checks
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_psc_info(...) -> AsyncHttpResponse[PscInfo]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AllowedRadius, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_psc_info(
- zip_code="zip_code",
- lab_id=1,
- radius=AllowedRadius.TEN,
- lab_account_id="lab_account_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**zip_code:** `str` â Zip code of the area to check
-
-
-
-
-
--
-
-**lab_id:** `int` â Lab ID to check for PSCs
-
-
-
-
-
--
-
-**radius:** `typing.Optional[AllowedRadius]` â Radius in which to search in miles. Note that we limit to 30 PSCs.
-
-
-
-
-
--
-
-**capabilities:** `typing.Optional[
- typing.Union[LabLocationCapability, typing.Sequence[LabLocationCapability]]
-]` â Filter for only locations with certain capabilities
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]` â Lab Account ID to use for availability checks
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_order_psc_info(...) -> AsyncHttpResponse[PscInfo]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AllowedRadius, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_order_psc_info(
- order_id="order_id",
- radius=AllowedRadius.TEN,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**radius:** `typing.Optional[AllowedRadius]` â Radius in which to search in miles
-
-
-
-
-
--
-
-**capabilities:** `typing.Optional[
- typing.Union[LabLocationCapability, typing.Sequence[LabLocationCapability]]
-]` â Filter for only locations with certain capabilities
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_result_pdf(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-This endpoint returns the lab results for the order.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_result_pdf(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_result_metadata(...) -> AsyncHttpResponse[LabResultsMetadata]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Return metadata related to order results, such as lab metadata,
-provider and sample dates.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_result_metadata(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_result_raw(...) -> AsyncHttpResponse[LabResultsRaw]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Return both metadata and raw json test data
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_result_raw(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_labels_pdf(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-This endpoint returns the printed labels for the order.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_labels_pdf(
- order_id="order_id",
- collection_date=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str`
-
-
-
-
-
--
-
-**collection_date:** `dt.datetime` â Collection date
-
-
-
-
-
--
-
-**number_of_labels:** `typing.Optional[int]` â Number of labels to generate
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_psc_appointment_availability(...) -> AsyncHttpResponse[AppointmentAvailabilitySlots]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AllowedRadius, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_psc_appointment_availability(
- start_date="start_date",
- zip_code="zip_code",
- radius=AllowedRadius.TEN,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**start_date:** `typing.Optional[str]` â Start date for appointment availability
-
-
-
-
-
--
-
-**site_codes:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` â List of site codes to fetch availability for
-
-
-
-
-
--
-
-**zip_code:** `typing.Optional[str]` â Zip code of the area to check
-
-
-
-
-
--
-
-**radius:** `typing.Optional[AllowedRadius]` â Radius in which to search. (meters)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.book_psc_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AppointmentBookingRequest, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.book_psc_appointment(
- order_id="order_id",
- request=AppointmentBookingRequest(
- booking_key="booking_key",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request:** `AppointmentBookingRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.reschedule_psc_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import AppointmentRescheduleRequest, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.reschedule_psc_appointment(
- order_id="order_id",
- request=AppointmentRescheduleRequest(
- booking_key="booking_key",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request:** `AppointmentRescheduleRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.cancel_psc_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.cancel_psc_appointment(
- order_id="order_id",
- cancellation_reason_id="cancellationReasonId",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**cancellation_reason_id:** `str`
-
-
-
-
-
--
-
-**note:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_psc_appointment_cancellation_reason() -> AsyncHttpResponse[typing.List[ClientFacingAppointmentCancellationReason]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_psc_appointment_cancellation_reason()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_psc_appointment(...) -> AsyncHttpResponse[ClientFacingAppointment]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get the appointment associated with an order.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_psc_appointment(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_order_collection_instruction_pdf(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET collection instructions for an order
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_order_collection_instruction_pdf(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_order_requistion_pdf(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET requisition pdf for an order
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_order_requistion_pdf(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_order_abn_pdf(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET ABN pdf for an order
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_order_abn_pdf(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.lab_tests.get_order(...) -> AsyncHttpResponse[ClientFacingOrder]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-GET individual order by ID.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.get_order(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.create_order(...) -> AsyncHttpResponse[PostOrderResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- Gender,
- PatientAddressWithValidation,
- PatientDetailsWithValidation,
- Vital,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.create_order(
- idempotency_key="X-Idempotency-Key",
- user_id="user_id",
- patient_details=PatientDetailsWithValidation(
- first_name="first_name",
- last_name="last_name",
- dob="dob",
- gender=Gender.FEMALE,
- phone_number="phone_number",
- email="email",
- ),
- patient_address=PatientAddressWithValidation(
- first_line="first_line",
- city="city",
- state="state",
- zip="zip",
- country="country",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**patient_details:** `PatientDetailsWithValidation`
-
-
-
-
-
--
-
-**patient_address:** `PatientAddressWithValidation`
-
-
-
-
-
--
-
-**idempotency_key:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**idempotency_error:** `typing.Optional[typing.Literal["no-cache"]]`
-
-
-
-
-
--
-
-**lab_test_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**order_set:** `typing.Optional[OrderSetRequest]`
-
-
-
-
-
--
-
-**collection_method:** `typing.Optional[LabTestCollectionMethod]`
-
-
-
-
-
--
-
-**physician:** `typing.Optional[PhysicianCreateRequest]`
-
-
-
-
-
--
-
-**health_insurance:** `typing.Optional[HealthInsuranceCreateRequest]`
-
-
-
-
-
--
-
-**priority:** `typing.Optional[bool]` â Defines whether order is priority or not. For some labs, this refers to a STAT order.
-
-
-
-
-
--
-
-**billing_type:** `typing.Optional[Billing]`
-
-
-
-
-
--
-
-**icd_codes:** `typing.Optional[typing.Sequence[str]]`
-
-
-
-
-
--
-
-**consents:** `typing.Optional[typing.Sequence[Consent]]`
-
-
-
-
-
--
-
-**activate_by:** `typing.Optional[str]` â Schedule an Order to be processed in a future date.
-
-
-
-
-
--
-
-**aoe_answers:** `typing.Optional[typing.Sequence[AoEAnswer]]`
-
-
-
-
-
--
-
-**passthrough:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**creator_member_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.import_order(...) -> AsyncHttpResponse[PostOrderResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- Billing,
- Gender,
- LabTestCollectionMethod,
- OrderSetRequest,
- PatientAddress,
- PatientDetailsWithValidation,
- Vital,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.import_order(
- user_id="user_id",
- billing_type=Billing.CLIENT_BILL,
- order_set=OrderSetRequest(),
- collection_method=LabTestCollectionMethod.TESTKIT,
- patient_details=PatientDetailsWithValidation(
- first_name="first_name",
- last_name="last_name",
- dob="dob",
- gender=Gender.FEMALE,
- phone_number="phone_number",
- email="email",
- ),
- patient_address=PatientAddress(
- receiver_name="receiver_name",
- first_line="first_line",
- city="city",
- state="state",
- zip="zip",
- country="country",
- ),
- sample_id="sample_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**billing_type:** `Billing`
-
-
-
-
-
--
-
-**order_set:** `OrderSetRequest`
-
-
-
-
-
--
-
-**collection_method:** `LabTestCollectionMethod`
-
-
-
-
-
--
-
-**patient_details:** `PatientDetailsWithValidation`
-
-
-
-
-
--
-
-**patient_address:** `PatientAddress`
-
-
-
-
-
--
-
-**sample_id:** `str`
-
-
-
-
-
--
-
-**physician:** `typing.Optional[PhysicianCreateRequest]`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.cancel_order(...) -> AsyncHttpResponse[PostOrderResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-POST cancel order
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.cancel_order(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.simulate_order_process(...) -> AsyncHttpResponse[typing.Any]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Get available test kits.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import OrderStatus, SimulationFlags, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.simulate_order_process(
- order_id="order_id",
- final_status=OrderStatus.RECEIVED_WALK_IN_TEST_ORDERED,
- delay=1,
- request=SimulationFlags(),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str`
-
-
-
-
-
--
-
-**final_status:** `typing.Optional[OrderStatus]`
-
-
-
-
-
--
-
-**delay:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request:** `typing.Optional[SimulationFlags]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.update_on_site_collection_order_draw_completed(...) -> AsyncHttpResponse[PostOrderResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-PATCH update on site collection order when draw is completed
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.update_on_site_collection_order_draw_completed(
- order_id="order_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_id:** `str` â Your Order ID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_tests.validate_icd_codes(...) -> AsyncHttpResponse[ValidateIcdCodesResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_tests.validate_icd_codes(
- codes=["codes"],
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**codes:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.testkit.register(...) -> AsyncHttpResponse[PostOrderResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- Gender,
- PatientAddressWithValidation,
- PatientDetailsWithValidation,
- Vital,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.testkit.register(
- sample_id="sample_id",
- patient_details=PatientDetailsWithValidation(
- first_name="first_name",
- last_name="last_name",
- dob="dob",
- gender=Gender.FEMALE,
- phone_number="phone_number",
- email="email",
- ),
- patient_address=PatientAddressWithValidation(
- first_line="first_line",
- city="city",
- state="state",
- zip="zip",
- country="country",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**sample_id:** `str`
-
-
-
-
-
--
-
-**patient_details:** `PatientDetailsWithValidation`
-
-
-
-
-
--
-
-**patient_address:** `PatientAddressWithValidation`
-
-
-
-
-
--
-
-**user_id:** `typing.Optional[str]` â The user ID of the patient.
-
-
-
-
-
--
-
-**physician:** `typing.Optional[PhysicianCreateRequestBase]`
-
-
-
-
-
--
-
-**health_insurance:** `typing.Optional[HealthInsuranceCreateRequest]`
-
-
-
-
-
--
-
-**consents:** `typing.Optional[typing.Sequence[Consent]]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.testkit.create_order(...) -> AsyncHttpResponse[PostOrderResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Creates an order for an unregistered testkit
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import ShippingAddressWithValidation, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.testkit.create_order(
- user_id="user_id",
- lab_test_id="lab_test_id",
- shipping_details=ShippingAddressWithValidation(
- receiver_name="receiver_name",
- first_line="first_line",
- city="city",
- state="state",
- zip="zip",
- country="country",
- phone_number="phone_number",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**lab_test_id:** `str`
-
-
-
-
-
--
-
-**shipping_details:** `ShippingAddressWithValidation`
-
-
-
-
-
--
-
-**passthrough:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**lab_account_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.order.resend_events(...) -> AsyncHttpResponse[ResendWebhookResponse]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Replay a webhook for a given set of orders
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.order.resend_events()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**order_ids:** `typing.Optional[typing.Sequence[str]]`
-
-
-
-
-
--
-
-**start_at:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**end_at:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.insurance.search_get_payor_info(...) -> AsyncHttpResponse[typing.List[ClientFacingPayorSearchResponse]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import PayorCodeExternalProvider, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.insurance.search_get_payor_info(
- insurance_name="insurance_name",
- provider=PayorCodeExternalProvider.CHANGE_HEALTHCARE,
- provider_payor_id="provider_payor_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**insurance_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[PayorCodeExternalProvider]`
-
-
-
-
-
--
-
-**provider_payor_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.insurance.search_payor_info(...) -> AsyncHttpResponse[typing.List[ClientFacingPayorSearchResponseDeprecated]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.insurance.search_payor_info()
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**insurance_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[PayorCodeExternalProvider]`
-
-
-
-
-
--
-
-**provider_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.insurance.search_diagnosis(...) -> AsyncHttpResponse[typing.List[ClientFacingDiagnosisInformation]]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.insurance.search_diagnosis(
- diagnosis_query="diagnosis_query",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**diagnosis_query:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.payor.create_payor(...) -> AsyncHttpResponse[ClientFacingPayor]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Address, Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.payor.create_payor(
- name="name",
- address=Address(
- first_line="first_line",
- country="country",
- zip="zip",
- city="city",
- state="state",
- ),
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**address:** `Address`
-
-
-
-
-
--
-
-**provider:** `typing.Optional[PayorCodeExternalProvider]`
-
-
-
-
-
--
-
-**provider_payor_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_report.parser_create_job(...) -> AsyncHttpResponse[ParsingJob]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Creates a parse job, uploads the file to provider, persists the job row,
-and starts the ParseLabReport. Returns a generated job_id.
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_report.parser_create_job(
- user_id="user_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**file:** `from __future__ import annotations
-
-core.File` â See core.File for more documentation
-
-
-
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**needs_human_review:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.lab_report.parser_get_job(...) -> AsyncHttpResponse[ParsingJob]
-
--
-
-#### đ Description
-
-
--
-
-
--
-
-Retrieves the parse job status and stored result if completed.
-
-Returns:
- ParseLabResultJobResponse with job status and parsed data (if complete)
-
-
-
-
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.lab_report.parser_get_job(
- job_id="job_id",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**job_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.aggregate.query_one(...) -> AsyncHttpResponse[AggregationResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import (
- AggregateExpr,
- AggregateExprFunc,
- Period,
- PeriodUnit,
- Query,
- RelativeTimeframe,
- SleepColumnExpr,
- SleepColumnExprSleep,
- Vital,
-)
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.aggregate.query_one(
- user_id="user_id",
- timeframe=RelativeTimeframe(
- anchor="anchor",
- past=Period(
- unit=PeriodUnit.MINUTE,
- ),
- ),
- queries=[
- Query(
- select=[
- AggregateExpr(
- arg=SleepColumnExpr(
- sleep=SleepColumnExprSleep.ID,
- ),
- func=AggregateExprFunc.MEAN,
- )
- ],
- )
- ],
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**timeframe:** `QueryBatchTimeframe`
-
-
-
-
-
--
-
-**queries:** `typing.Sequence[Query]`
-
-
-
-
-
--
-
-**config:** `typing.Optional[QueryConfig]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.aggregate.get_result_table_for_continuous_query(...) -> AsyncHttpResponse[AggregationResult]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.aggregate.get_result_table_for_continuous_query(
- user_id="user_id",
- query_id_or_slug="query_id_or_slug",
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**query_id_or_slug:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.aggregate.get_task_history_for_continuous_query(...) -> AsyncHttpResponse[ContinuousQueryTaskHistoryResponse]
-
--
-
-#### đ Usage
-
-
--
-
-
--
-
-```python
-from vital import Vital
-
-client = Vital(
- api_key="YOUR_API_KEY",
-)
-client.aggregate.get_task_history_for_continuous_query(
- user_id="user_id",
- query_id_or_slug="query_id_or_slug",
- next_cursor="next_cursor",
- limit=1,
-)
-
-```
-
-
-
-
-
-#### âī¸ Parameters
-
-
--
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**query_id_or_slug:** `str`
-
-
-
-
-
--
-
-**next_cursor:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` â Request-specific configuration.
-
-
-
-
-
-
-
-
-
-