@tryterra/react-native 2.1.0 → 2.2.1

package/android/src/bridgeCore/kotlin/co/tryterra/sdk/bridge/generated/BridgeTypes.kt

@@ -68,6 +68,19 @@ public enum class DataCategory {
     SLEEP,
     @SerialName("nutrition")
     NUTRITION,
+    /**
+     * Read-only on both platforms: menstruation.flow reads it and neither SDK has a write route
+     * for it.
+     */
+    @SerialName("menstruation")
+    MENSTRUATION,
+    /**
+     * HealthKit's characteristics; Health Connect has no counterpart.
+     *
+     * Available on ios only.
+     */
+    @SerialName("athlete")
+    ATHLETE,
 }
 
 @Serializable
@@ -105,6 +118,159 @@ public enum class MotionContext {
     ACTIVE,
 }
 
+/**
+ * On both platforms, wire names strip HKQuantityTypeIdentifierDietary from HealthKit
+ * identifiers and lowercase the first letter. Units: kcal for energyConsumed; grams for
+ * protein, carbohydrates, the four fats, sugar and fiber; milligrams for everything else,
+ * never micrograms.
+ */
+@Serializable
+public enum class Nutrient {
+    @SerialName("energyConsumed")
+    ENERGY_CONSUMED,
+    @SerialName("protein")
+    PROTEIN,
+    @SerialName("carbohydrates")
+    CARBOHYDRATES,
+    @SerialName("fatTotal")
+    FAT_TOTAL,
+    @SerialName("fatSaturated")
+    FAT_SATURATED,
+    @SerialName("fatMonounsaturated")
+    FAT_MONOUNSATURATED,
+    @SerialName("fatPolyunsaturated")
+    FAT_POLYUNSATURATED,
+    @SerialName("sugar")
+    SUGAR,
+    @SerialName("fiber")
+    FIBER,
+    @SerialName("cholesterol")
+    CHOLESTEROL,
+    @SerialName("sodium")
+    SODIUM,
+    @SerialName("potassium")
+    POTASSIUM,
+    @SerialName("calcium")
+    CALCIUM,
+    @SerialName("iron")
+    IRON,
+    @SerialName("magnesium")
+    MAGNESIUM,
+    @SerialName("zinc")
+    ZINC,
+    @SerialName("phosphorus")
+    PHOSPHORUS,
+    @SerialName("iodine")
+    IODINE,
+    @SerialName("manganese")
+    MANGANESE,
+    @SerialName("molybdenum")
+    MOLYBDENUM,
+    @SerialName("selenium")
+    SELENIUM,
+    @SerialName("copper")
+    COPPER,
+    @SerialName("chromium")
+    CHROMIUM,
+    @SerialName("chloride")
+    CHLORIDE,
+    @SerialName("caffeine")
+    CAFFEINE,
+    @SerialName("vitaminA")
+    VITAMIN_A,
+    @SerialName("vitaminC")
+    VITAMIN_C,
+    @SerialName("vitaminD")
+    VITAMIN_D,
+    @SerialName("vitaminE")
+    VITAMIN_E,
+    @SerialName("vitaminK")
+    VITAMIN_K,
+    @SerialName("vitaminB6")
+    VITAMIN_B6,
+    @SerialName("vitaminB12")
+    VITAMIN_B12,
+    @SerialName("thiamin")
+    THIAMIN,
+    @SerialName("riboflavin")
+    RIBOFLAVIN,
+    @SerialName("niacin")
+    NIACIN,
+    @SerialName("folate")
+    FOLATE,
+    @SerialName("biotin")
+    BIOTIN,
+    @SerialName("pantothenicAcid")
+    PANTOTHENIC_ACID,
+}
+
+/**
+ * Which meal a quantity was logged against. unknown is the store's explicit answer, not an
+ * absence: HealthKit has no meal type at all, so every iOS quantity is unknown.
+ */
+@Serializable
+public enum class MealType {
+    @SerialName("breakfast")
+    BREAKFAST,
+    @SerialName("lunch")
+    LUNCH,
+    @SerialName("dinner")
+    DINNER,
+    @SerialName("snack")
+    SNACK,
+    @SerialName("unknown")
+    UNKNOWN,
+}
+
+/** How heavy a logged day's flow was. */
+@Serializable
+public enum class MenstruationFlow {
+    @SerialName("unspecified")
+    UNSPECIFIED,
+    @SerialName("light")
+    LIGHT,
+    @SerialName("medium")
+    MEDIUM,
+    @SerialName("heavy")
+    HEAVY,
+    /**
+     * noFlow avoids ambiguity with Optional.none. Health Connect has no constant for it, so
+     * Android never produces it.
+     */
+    @SerialName("none")
+    NO_FLOW,
+}
+
+/** Available on ios only. */
+@Serializable
+public enum class BiologicalSex {
+    @SerialName("female")
+    FEMALE,
+    @SerialName("male")
+    MALE,
+    @SerialName("other")
+    OTHER,
+    /**
+     * The characteristic exists and holds no value, or reading it failed. The store's explicit
+     * unknown.
+     */
+    @SerialName("notSet")
+    NOT_SET,
+}
+
+/**
+ * A move-time user's daily totals are minutes rather than active energy.
+ *
+ * Available on ios only.
+ */
+@Serializable
+public enum class ActivityMoveMode {
+    @SerialName("activeEnergy")
+    ACTIVE_ENERGY,
+    @SerialName("appleMoveTime")
+    APPLE_MOVE_TIME,
+}
+
 /**
  * Why background delivery is restricted. Android discloses which; Apple reports the state
  * without a reason.
@@ -254,6 +420,179 @@ public enum class WorkoutSchedulingStatus {
     AUTHORIZED,
 }
 
+/**
+ * distance* are metres, *EnergyBurned kilocalories, flightsClimbed a count, and
+ * appleExerciseTime minutes.
+ */
+@Serializable
+public enum class DayTotalMetric {
+    @SerialName("distanceWalkingRunning")
+    DISTANCE_WALKING_RUNNING,
+    /** Health Connect does not split distance by activity, so only Apple ever answers it. */
+    @SerialName("distanceCycling")
+    DISTANCE_CYCLING,
+    @SerialName("distanceSwimming")
+    DISTANCE_SWIMMING,
+    @SerialName("distanceWheelchair")
+    DISTANCE_WHEELCHAIR,
+    @SerialName("activeEnergyBurned")
+    ACTIVE_ENERGY_BURNED,
+    @SerialName("basalEnergyBurned")
+    BASAL_ENERGY_BURNED,
+    @SerialName("flightsClimbed")
+    FLIGHTS_CLIMBED,
+    /**
+     * The exercise ring, in minutes. Health Connect has no such figure: summing session durations
+     * is a different number.
+     *
+     * Available on ios only.
+     */
+    @SerialName("appleExerciseTime")
+    APPLE_EXERCISE_TIME,
+}
+
+/** activeEnergy and basalEnergy are kilocalories, distance metres, floorsClimbed a count. */
+@Serializable
+public enum class IntradayMetric {
+    @SerialName("activeEnergy")
+    ACTIVE_ENERGY,
+    /**
+     * Health Connect has no basal energy record; its basal metabolic rate is a body measurement
+     * and is not this.
+     *
+     * Available on ios only.
+     */
+    @SerialName("basalEnergy")
+    BASAL_ENERGY,
+    @SerialName("distance")
+    DISTANCE,
+    @SerialName("floorsClimbed")
+    FLOORS_CLIMBED,
+}
+
+/** speed is metres per second, power watts, cadence pedal revolutions per minute. */
+@Serializable
+public enum class WorkoutIntensityMetric {
+    @SerialName("speed")
+    SPEED,
+    @SerialName("power")
+    POWER,
+    @SerialName("cadence")
+    CADENCE,
+}
+
+/**
+ * The body composition figure a measurement carries. weight and leanBodyMass are kilograms,
+ * height centimetres, bodyFatPercentage a fraction in 0..1, bmi dimensionless.
+ */
+@Serializable
+public enum class BodyMetric {
+    @SerialName("weight")
+    WEIGHT,
+    @SerialName("height")
+    HEIGHT,
+    @SerialName("bodyFatPercentage")
+    BODY_FAT_PERCENTAGE,
+    @SerialName("leanBodyMass")
+    LEAN_BODY_MASS,
+    /**
+     * Health Connect has no BMI record.
+     *
+     * Available on ios only.
+     */
+    @SerialName("bmi")
+    BMI,
+}
+
+/** The unit the writing app chose. Never converted on the device. */
+@Serializable
+public enum class BloodGlucoseUnit {
+    @SerialName("mg/dL")
+    MILLIGRAMS_PER_DECILITRE,
+    @SerialName("mmol/L")
+    MILLIMOLES_PER_LITRE,
+}
+
+/** unknown is the store saying nothing about the meal, distinct from absent. */
+@Serializable
+public enum class GlucoseMealTime {
+    @SerialName("preprandial")
+    PREPRANDIAL,
+    @SerialName("postprandial")
+    POSTPRANDIAL,
+    @SerialName("unknown")
+    UNKNOWN,
+}
+
+/** interstitial is a continuous monitor. */
+@Serializable
+public enum class GlucoseSpecimen {
+    @SerialName("capillary")
+    CAPILLARY,
+    @SerialName("interstitial")
+    INTERSTITIAL,
+    @SerialName("plasma")
+    PLASMA,
+    @SerialName("serum")
+    SERUM,
+    @SerialName("tears")
+    TEARS,
+    @SerialName("wholeBlood")
+    WHOLE_BLOOD,
+    @SerialName("unknown")
+    UNKNOWN,
+}
+
+/**
+ * body and basal are absolute; wrist and skin are deltas from a baseline and routinely
+ * negative.
+ */
+@Serializable
+public enum class BodyTemperatureMetric {
+    @SerialName("body")
+    BODY,
+    @SerialName("basal")
+    BASAL,
+    /**
+     * HealthKit's sleeping wrist temperature. Health Connect has no such record.
+     *
+     * Available on ios only.
+     */
+    @SerialName("wrist")
+    WRIST,
+    @SerialName("skin")
+    SKIN,
+}
+
+/** HealthKit records SDNN only and Health Connect RMSSD only; they are never one series. */
+@Serializable
+public enum class HeartRateVariabilityMetric {
+    @SerialName("sdnn")
+    SDNN,
+    @SerialName("rmssd")
+    RMSSD,
+}
+
+@Serializable
+public enum class VO2MaxTestType {
+    @SerialName("maxExercise")
+    MAX_EXERCISE,
+    @SerialName("predictedSubMaxExercise")
+    PREDICTED_SUB_MAX_EXERCISE,
+    @SerialName("predictedNonExercise")
+    PREDICTED_NON_EXERCISE,
+}
+
+@Serializable
+public enum class MenstrualEventKind {
+    @SerialName("intermenstrualBleeding")
+    INTERMENSTRUAL_BLEEDING,
+    @SerialName("ovulationTest")
+    OVULATION_TEST,
+    @SerialName("cervicalMucus")
+    CERVICAL_MUCUS,
+}
+
 /**
  * The person a connect is for. A stored link is restored only for the person it was made for;
  * anybody else gets a fresh link. Never sent to Terra as identity.
@@ -405,6 +744,102 @@ public sealed interface StreamMessage {
     public data object Complete : StreamMessage
 }
 
+/**
+ * What a BodyReading measured, with the unit fixed by the variant. Blood glucose alone keeps
+ * the writer's unit.
+ */
+@Serializable
+@OptIn(ExperimentalSerializationApi::class)
+@JsonClassDiscriminator("type")
+public sealed interface BodyReadingKind {
+    @Serializable
+    @SerialName("measurement")
+    public data class Measurement(public val metric: BodyMetric, public val value: Double) : BodyReadingKind
+    /** Millimetres of mercury, both halves of one reading. */
+    @Serializable
+    @SerialName("bloodPressure")
+    public data class BloodPressure(public val systolic: Double, public val diastolic: Double) : BodyReadingKind
+    @Serializable
+    @SerialName("bloodGlucose")
+    public data class BloodGlucose(public val value: Double, public val unit: BloodGlucoseUnit, public val mealTime: GlucoseMealTime? = null, public val specimen: GlucoseSpecimen? = null) : BodyReadingKind
+    /** A fraction in 0..1, never a number out of a hundred. */
+    @Serializable
+    @SerialName("oxygenSaturation")
+    public data class OxygenSaturation(public val fraction: Double) : BodyReadingKind
+    @Serializable
+    @SerialName("temperature")
+    public data class Temperature(public val metric: BodyTemperatureMetric, public val celsius: Double) : BodyReadingKind
+    @Serializable
+    @SerialName("heartRateVariability")
+    public data class HeartRateVariability(public val metric: HeartRateVariabilityMetric, public val milliseconds: Double) : BodyReadingKind
+    @Serializable
+    @SerialName("respiratoryRate")
+    public data class RespiratoryRate(public val breathsPerMinute: Double) : BodyReadingKind
+    /** Millilitres of oxygen per kilogram per minute. */
+    @Serializable
+    @SerialName("vo2Max")
+    public data class Vo2Max(public val millilitresPerKilogramMinute: Double, public val testType: VO2MaxTestType? = null) : BodyReadingKind
+}
+
+/**
+ * Apple's store is part of the OS, so it is there or the device cannot have it; Health Connect
+ * is an app a person can lack.
+ */
+@Serializable
+@OptIn(ExperimentalSerializationApi::class)
+@JsonClassDiscriminator("kind")
+public sealed interface StoreAvailability {
+    @Serializable
+    @SerialName("available")
+    public data object Available : StoreAvailability
+    /**
+     * No HealthKit on this device: an iPad before iPadOS 17, or a Mac.
+     *
+     * Available on ios only.
+     */
+    @Serializable
+    @SerialName("unsupportedDevice")
+    public data object UnsupportedDevice : StoreAvailability
+    /**
+     * No Health Connect on Android 13 or below, or no Samsung Health. A Play Store link fixes the
+     * first.
+     *
+     * Available on android only.
+     */
+    @Serializable
+    @SerialName("providerAppMissing")
+    public data object ProviderAppMissing : StoreAvailability
+    /** Available on android only. */
+    @Serializable
+    @SerialName("providerAppTooOld")
+    public data class ProviderAppTooOld(public val installed: String) : StoreAvailability
+    /**
+     * The source's add-on artifact is not in the app.
+     *
+     * Available on android only.
+     */
+    @Serializable
+    @SerialName("moduleMissing")
+    public data object ModuleMissing : StoreAvailability
+    /**
+     * The store's partner policy covers none of the record types. Which ones is in the native
+     * report.
+     *
+     * Available on android only.
+     */
+    @Serializable
+    @SerialName("partnerPolicyMissing")
+    public data object PartnerPolicyMissing : StoreAvailability
+    /**
+     * The provider app lacks a feature the store needs. Which one is in the native report.
+     *
+     * Available on android only.
+     */
+    @Serializable
+    @SerialName("featureUnavailable")
+    public data object FeatureUnavailable : StoreAvailability
+}
+
 public object DataCategorySetSerializer : KSerializer<List<DataCategory>> {
     private val list = ListSerializer(DataCategory.serializer())
     override val descriptor: SerialDescriptor = list.descriptor
@@ -497,6 +932,54 @@ public data class Workout(
     public val source: SampleSource,
     public val userEntered: Boolean,
     public val timeZone: String? = null,
+    /**
+     * ExerciseSessionRecord.title on Android; HKMetadataKeyWorkoutBrandName on Apple, which has no
+     * title field.
+     */
+    public val title: String? = null,
+)
+
+/** Quantities of one meal share foodCorrelationId. */
+@Serializable
+public data class DietaryQuantity(
+    public val id: String,
+    public val nutrient: Nutrient,
+    public val value: Double,
+    public val start: String,
+    public val end: String,
+    public val mealType: MealType,
+    public val name: String? = null,
+    /**
+     * HealthKit's food correlation, absent for a loose quantity. Always set on Android, where it
+     * is the NutritionRecord's id - the id nutrition.delete takes for a meal this app logged.
+     */
+    public val foodCorrelationId: String? = null,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+/** start and end are the local midnights of that day in timeZone. */
+@Serializable
+public data class MenstruationFlowDay(
+    public val id: String,
+    public val start: String,
+    public val end: String,
+    public val flow: MenstruationFlow,
+    public val cycleStart: Boolean,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+/** Available on ios only. */
+@Serializable
+public data class AthleteProfile(
+    public val biologicalSex: BiologicalSex? = null,
+    /** A calendar day, as HealthKit stores it, never an instant. */
+    public val dateOfBirth: String? = null,
+    public val wheelchairUse: Boolean? = null,
+    public val activityMoveMode: ActivityMoveMode? = null,
 )
 
 /** A day whose data changed. Carries no health value by construction. */
@@ -825,6 +1308,49 @@ public data class WorkoutList(
     public val samples: List<Workout>,
 )
 
+@Serializable
+public data class DietaryQuantityList(
+    public val samples: List<DietaryQuantity>,
+)
+
+@Serializable
+public data class MenstruationFlowDayList(
+    public val samples: List<MenstruationFlowDay>,
+)
+
+/** A cycle event logged at an instant. */
+@Serializable
+public data class MenstrualEvent(
+    public val id: String,
+    public val kind: MenstrualEventKind,
+    public val time: String,
+    /**
+     * ovulationTest: negative, positive, high, indeterminate or luteinizingHormoneSurge.
+     * cervicalMucus: dry, sticky, creamy, watery, eggWhite or unusual. Absent for
+     * intermenstrualBleeding, which is a flag.
+     */
+    public val value: String? = null,
+    /**
+     * The store's own record type, passed through: OvulationTestRecord on Android,
+     * HKCategoryTypeIdentifierOvulationTestResult on Apple.
+     */
+    public val storeIdentifier: String,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+@Serializable
+public data class MenstrualEventList(
+    public val samples: List<MenstrualEvent>,
+)
+
+/** Available on ios only. */
+@Serializable
+public data class AthleteProfileResult(
+    public val profile: AthleteProfile? = null,
+)
+
 /** Available on ios only. */
 @Serializable
 public data class PlannedWorkoutList(
@@ -876,6 +1402,152 @@ public data class NutritionEntryList(
     public val entries: List<NutritionEntry>,
 )
 
+/**
+ * The store's own total for one local day, from its statistics engine. start and end are that
+ * day's midnights.
+ */
+@Serializable
+public data class DayTotal(
+    public val metric: DayTotalMetric,
+    public val start: String,
+    public val end: String,
+    public val value: Double,
+    public val unit: String,
+    public val timeZone: String? = null,
+)
+
+/**
+ * One record a day total is made of, as the store holds it. A record crossing midnight is
+ * whole.
+ */
+@Serializable
+public data class IntradaySample(
+    public val id: String,
+    public val metric: IntradayMetric,
+    public val start: String,
+    public val end: String,
+    public val value: Double,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+/** The store's own resting heart rate for a day, never derived from heart rate readings. */
+@Serializable
+public data class RestingHeartRateSample(
+    public val id: String,
+    public val start: String,
+    public val end: String,
+    public val beatsPerMinute: Double,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+/** A point reading has start equal to end; skin and wrist temperature span a stretch. */
+@Serializable
+public data class BodyReading(
+    public val id: String,
+    public val kind: BodyReadingKind,
+    public val start: String,
+    public val end: String,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+@Serializable
+public data class RoutePoint(
+    public val time: String,
+    public val latitude: Double,
+    public val longitude: Double,
+)
+
+/**
+ * The GPS track a workout left, thinned to one point a second and at most 5,000 points. start
+ * and end are the first and last point.
+ */
+@Serializable
+public data class WorkoutRoute(
+    public val id: String,
+    public val workoutId: String,
+    public val start: String,
+    public val end: String,
+    public val points: List<RoutePoint>,
+    public val source: SampleSource,
+    public val timeZone: String? = null,
+)
+
+/** One speed, power or cadence reading. Android's are instants, so start equals end there. */
+@Serializable
+public data class WorkoutIntensitySample(
+    public val id: String,
+    public val metric: WorkoutIntensityMetric,
+    /**
+     * Set on Apple, where HealthKit stores a reading inside its workout. Health Connect stores
+     * them free-standing, so Android leaves it absent rather than guessing by time.
+     */
+    public val workoutId: String? = null,
+    public val start: String,
+    public val end: String,
+    public val value: Double,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+/** One drink, in millilitres. */
+@Serializable
+public data class HydrationSample(
+    public val id: String,
+    public val start: String,
+    public val end: String,
+    public val millilitres: Double,
+    public val source: SampleSource,
+    public val userEntered: Boolean,
+    public val timeZone: String? = null,
+)
+
+@Serializable
+public data class DayTotalList(
+    public val totals: List<DayTotal>,
+)
+
+@Serializable
+public data class IntradaySampleList(
+    public val samples: List<IntradaySample>,
+)
+
+@Serializable
+public data class RestingHeartRateList(
+    public val samples: List<RestingHeartRateSample>,
+)
+
+@Serializable
+public data class BodyReadingList(
+    public val samples: List<BodyReading>,
+)
+
+@Serializable
+public data class WorkoutRouteList(
+    public val routes: List<WorkoutRoute>,
+)
+
+@Serializable
+public data class WorkoutIntensityList(
+    public val samples: List<WorkoutIntensitySample>,
+)
+
+@Serializable
+public data class HydrationList(
+    public val samples: List<HydrationSample>,
+)
+
+@Serializable
+public data class AvailabilityResult(
+    public val availability: StoreAvailability,
+)
+
 public object TerraEventEnvelope {
     public fun validate(value: TerraEvent) {
         if ((value["at"] as? JsonPrimitive)?.isString != true) {