ExOura.Client.SandboxRoutes (ex_oura v4.0.0)

Copy Markdown View Source

Provides API endpoints related to sandbox routes

Summary

Functions

Functions

sandbox_multiple_daily_activity_documents_v2_sandbox_usercollection_daily_activity_get(opts \\ [])

@spec sandbox_multiple_daily_activity_documents_v2_sandbox_usercollection_daily_activity_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailyActivity.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Activity Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_daily_cardiovascular_age_documents_v2_sandbox_usercollection_daily_cardiovascular_age_get(opts \\ [])

@spec sandbox_multiple_daily_cardiovascular_age_documents_v2_sandbox_usercollection_daily_cardiovascular_age_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailyCardiovascularAge.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Cardiovascular Age Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_daily_readiness_documents_v2_sandbox_usercollection_daily_readiness_get(opts \\ [])

@spec sandbox_multiple_daily_readiness_documents_v2_sandbox_usercollection_daily_readiness_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailyReadiness.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Readiness Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_daily_resilience_documents_v2_sandbox_usercollection_daily_resilience_get(opts \\ [])

@spec sandbox_multiple_daily_resilience_documents_v2_sandbox_usercollection_daily_resilience_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDailyResilienceModel.t()
   | ExOura.Client.MultiDocumentResponseDict.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Resilience Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_daily_sleep_documents_v2_sandbox_usercollection_daily_sleep_get(opts \\ [])

@spec sandbox_multiple_daily_sleep_documents_v2_sandbox_usercollection_daily_sleep_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailySleep.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Sleep Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_daily_spo2_documents_v2_sandbox_usercollection_daily_spo2_get(opts \\ [])

@spec sandbox_multiple_daily_spo2_documents_v2_sandbox_usercollection_daily_spo2_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailySpO2.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Spo2 Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_daily_stress_documents_v2_sandbox_usercollection_daily_stress_get(opts \\ [])

@spec sandbox_multiple_daily_stress_documents_v2_sandbox_usercollection_daily_stress_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailyStress.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Daily Stress Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_enhanced_tag_documents_v2_sandbox_usercollection_enhanced_tag_get(opts \\ [])

@spec sandbox_multiple_enhanced_tag_documents_v2_sandbox_usercollection_enhanced_tag_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponseEnhancedTagModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Enhanced Tag Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_heartrate_documents_v2_sandbox_usercollection_heartrate_get(opts \\ [])

@spec sandbox_multiple_heartrate_documents_v2_sandbox_usercollection_heartrate_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.TimeSeriesResponseDict.t()
   | ExOura.Client.TimeSeriesResponsePublicHeartRateRow.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Heartrate Documents

Options

  • start_datetime
  • end_datetime
  • next_token

sandbox_multiple_rest_mode_period_documents_v2_sandbox_usercollection_rest_mode_period_get(opts \\ [])

@spec sandbox_multiple_rest_mode_period_documents_v2_sandbox_usercollection_rest_mode_period_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicRestModePeriod.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Rest Mode Period Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_ring_battery_level_documents_v2_sandbox_usercollection_ring_battery_level_get(opts \\ [])

@spec sandbox_multiple_ring_battery_level_documents_v2_sandbox_usercollection_ring_battery_level_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.TimeSeriesResponseDict.t()
   | ExOura.Client.TimeSeriesResponsePublicRingBatteryLevelRow.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Ring Battery Level Documents

Options

  • start_datetime
  • end_datetime
  • next_token

sandbox_multiple_ring_configuration_documents_v2_sandbox_usercollection_ring_configuration_get(opts \\ [])

@spec sandbox_multiple_ring_configuration_documents_v2_sandbox_usercollection_ring_configuration_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicRingConfiguration.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Ring Configuration Documents

Options

  • next_token

sandbox_multiple_session_documents_v2_sandbox_usercollection_session_get(opts \\ [])

@spec sandbox_multiple_session_documents_v2_sandbox_usercollection_session_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicSession.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Session Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_sleep_documents_v2_sandbox_usercollection_sleep_get(opts \\ [])

@spec sandbox_multiple_sleep_documents_v2_sandbox_usercollection_sleep_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicModifiedSleepModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Sleep Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_sleep_time_documents_v2_sandbox_usercollection_sleep_time_get(opts \\ [])

@spec sandbox_multiple_sleep_time_documents_v2_sandbox_usercollection_sleep_time_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicSleepTime.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Sleep Time Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_tag_documents_v2_sandbox_usercollection_tag_get(opts \\ [])

@spec sandbox_multiple_tag_documents_v2_sandbox_usercollection_tag_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponseTagModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Tag Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_v_o2_max_documents_v2_sandbox_usercollection_v_o2_max_get(opts \\ [])

@spec sandbox_multiple_v_o2_max_documents_v2_sandbox_usercollection_v_o2_max_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicVo2Max.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Vo2 Max Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_multiple_workout_documents_v2_sandbox_usercollection_workout_get(opts \\ [])

@spec sandbox_multiple_workout_documents_v2_sandbox_usercollection_workout_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicWorkout.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Multiple Workout Documents

Options

  • start_date
  • end_date
  • next_token

sandbox_single_daily_activity_document_v2_sandbox_usercollection_daily_activity_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_activity_document_v2_sandbox_usercollection_daily_activity_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailyActivity.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Activity Document

sandbox_single_daily_cardiovascular_age_document_v2_sandbox_usercollection_daily_cardiovascular_age_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_cardiovascular_age_document_v2_sandbox_usercollection_daily_cardiovascular_age_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailyCardiovascularAge.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Cardiovascular Age Document

sandbox_single_daily_readiness_document_v2_sandbox_usercollection_daily_readiness_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_readiness_document_v2_sandbox_usercollection_daily_readiness_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailyReadiness.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Readiness Document

sandbox_single_daily_resilience_document_v2_sandbox_usercollection_daily_resilience_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_resilience_document_v2_sandbox_usercollection_daily_resilience_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.DailyResilienceModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Resilience Document

sandbox_single_daily_sleep_document_v2_sandbox_usercollection_daily_sleep_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_sleep_document_v2_sandbox_usercollection_daily_sleep_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailySleep.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Sleep Document

sandbox_single_daily_spo2_document_v2_sandbox_usercollection_daily_spo2_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_spo2_document_v2_sandbox_usercollection_daily_spo2_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailySpO2.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Spo2 Document

sandbox_single_daily_stress_document_v2_sandbox_usercollection_daily_stress_document_id_get(document_id, opts \\ [])

@spec sandbox_single_daily_stress_document_v2_sandbox_usercollection_daily_stress_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailyStress.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Daily Stress Document

sandbox_single_enhanced_tag_document_v2_sandbox_usercollection_enhanced_tag_document_id_get(document_id, opts \\ [])

@spec sandbox_single_enhanced_tag_document_v2_sandbox_usercollection_enhanced_tag_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.EnhancedTagModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Enhanced Tag Document

sandbox_single_rest_mode_period_document_v2_sandbox_usercollection_rest_mode_period_document_id_get(document_id, opts \\ [])

@spec sandbox_single_rest_mode_period_document_v2_sandbox_usercollection_rest_mode_period_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicRestModePeriod.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Rest Mode Period Document

sandbox_single_ring_configuration_document_v2_sandbox_usercollection_ring_configuration_document_id_get(document_id, opts \\ [])

@spec sandbox_single_ring_configuration_document_v2_sandbox_usercollection_ring_configuration_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicRingConfiguration.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Ring Configuration Document

sandbox_single_session_document_v2_sandbox_usercollection_session_document_id_get(document_id, opts \\ [])

@spec sandbox_single_session_document_v2_sandbox_usercollection_session_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicSession.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Session Document

sandbox_single_sleep_document_v2_sandbox_usercollection_sleep_document_id_get(document_id, opts \\ [])

@spec sandbox_single_sleep_document_v2_sandbox_usercollection_sleep_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicModifiedSleepModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Sleep Document

sandbox_single_sleep_time_document_v2_sandbox_usercollection_sleep_time_document_id_get(document_id, opts \\ [])

@spec sandbox_single_sleep_time_document_v2_sandbox_usercollection_sleep_time_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicSleepTime.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Sleep Time Document

sandbox_single_tag_document_v2_sandbox_usercollection_tag_document_id_get(document_id, opts \\ [])

@spec sandbox_single_tag_document_v2_sandbox_usercollection_tag_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.TagModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Tag Document

sandbox_single_v_o2_max_document_v2_sandbox_usercollection_v_o2_max_document_id_get(document_id, opts \\ [])

@spec sandbox_single_v_o2_max_document_v2_sandbox_usercollection_v_o2_max_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicVo2Max.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Vo2 Max Document

sandbox_single_workout_document_v2_sandbox_usercollection_workout_document_id_get(document_id, opts \\ [])

@spec sandbox_single_workout_document_v2_sandbox_usercollection_workout_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicWorkout.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Sandbox - Single Workout Document