Data Models

Config

pydantic model pylibrelinkup.models.config.AlarmRules

Bases: ConfigBaseModel

AlarmRules class to store alarm rules data.

Show JSON schema

{
   "title": "AlarmRules",
   "description": "AlarmRules class to store alarm rules data.",
   "type": "object",
   "properties": {
      "c": {
         "default": false,
         "title": "C",
         "type": "boolean"
      },
      "h": {
         "$ref": "#/$defs/H"
      },
      "f": {
         "$ref": "#/$defs/F"
      },
      "l": {
         "$ref": "#/$defs/L"
      },
      "nd": {
         "$ref": "#/$defs/Nd"
      },
      "p": {
         "default": 0,
         "title": "P",
         "type": "integer"
      },
      "r": {
         "default": 0,
         "title": "R",
         "type": "integer"
      },
      "std": {
         "$ref": "#/$defs/Std"
      }
   },
   "$defs": {
      "F": {
         "description": "F class to store F data.",
         "properties": {
            "th": {
               "default": 0,
               "title": "Th",
               "type": "integer"
            },
            "thmm": {
               "default": 0.0,
               "title": "Thmm",
               "type": "number"
            },
            "d": {
               "default": 0,
               "title": "D",
               "type": "integer"
            },
            "tl": {
               "default": 0,
               "title": "Tl",
               "type": "integer"
            },
            "tlmm": {
               "default": 0.0,
               "title": "Tlmm",
               "type": "number"
            }
         },
         "title": "F",
         "type": "object"
      },
      "H": {
         "description": "H class to store H data.",
         "properties": {
            "th": {
               "default": 0,
               "title": "Th",
               "type": "integer"
            },
            "thmm": {
               "default": 0.0,
               "title": "Thmm",
               "type": "number"
            },
            "d": {
               "default": 0,
               "title": "D",
               "type": "integer"
            },
            "f": {
               "default": 0.0,
               "title": "F",
               "type": "number"
            }
         },
         "title": "H",
         "type": "object"
      },
      "L": {
         "description": "L class to store L data.",
         "properties": {
            "th": {
               "default": 0,
               "title": "Th",
               "type": "integer"
            },
            "thmm": {
               "default": 0.0,
               "title": "Thmm",
               "type": "number"
            },
            "d": {
               "default": 0,
               "title": "D",
               "type": "integer"
            },
            "tl": {
               "default": 0,
               "title": "Tl",
               "type": "integer"
            },
            "tlmm": {
               "default": 0.0,
               "title": "Tlmm",
               "type": "number"
            }
         },
         "title": "L",
         "type": "object"
      },
      "Nd": {
         "description": "Nd class to store Nd data.",
         "properties": {
            "i": {
               "default": 0,
               "title": "I",
               "type": "integer"
            },
            "r": {
               "default": 0,
               "title": "R",
               "type": "integer"
            },
            "l": {
               "default": 0,
               "title": "L",
               "type": "integer"
            }
         },
         "title": "Nd",
         "type": "object"
      },
      "Std": {
         "description": "Std class to store Std data.",
         "properties": {
            "sd": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Sd"
            }
         },
         "title": "Std",
         "type": "object"
      }
   },
   "required": [
      "h",
      "f",
      "l",
      "nd",
      "std"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• c (bool)

• f (pylibrelinkup.models.data.F)

• h (pylibrelinkup.models.data.H)

• l (pylibrelinkup.models.data.L)

• nd (pylibrelinkup.models.data.Nd)

• p (int)

• r (int)

• std (pylibrelinkup.models.data.Std)

Validators:

field c: bool = False

Validated by:

• preprocess_data

field f: F [Required]

Validated by:

• preprocess_data

field h: H [Required]

Validated by:

• preprocess_data

field l: L [Required]

Validated by:

• preprocess_data

field nd: Nd [Required]

Validated by:

• preprocess_data

field p: int = 0

Validated by:

• preprocess_data

field r: int = 0

Validated by:

• preprocess_data

field std: Std [Required]

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.config.FixedLowAlarmValues

Bases: ConfigBaseModel

FixedLowAlarmValues class to store fixed alarm values.

Show JSON schema

{
   "title": "FixedLowAlarmValues",
   "description": "FixedLowAlarmValues class to store fixed alarm values.",
   "type": "object",
   "properties": {
      "mgdl": {
         "default": 0,
         "title": "Mgdl",
         "type": "integer"
      },
      "mmoll": {
         "default": 0.0,
         "title": "Mmoll",
         "type": "number"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• mgdl (int)

• mmoll (float)

Validators:

field mgdl: int = 0

Validated by:

• preprocess_data

field mmoll: float = 0.0

Validated by:

• preprocess_data

Connections

pydantic model pylibrelinkup.models.connection.GraphResponse

Bases: APIResponse

GraphResponse class to store API graph data endpoint response.

Show JSON schema

{
   "title": "GraphResponse",
   "description": "GraphResponse class to store API graph data endpoint response.",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "ticket": {
         "$ref": "#/$defs/Ticket"
      },
      "data": {
         "$ref": "#/$defs/Data"
      }
   },
   "$defs": {
      "ActiveSensor": {
         "description": "ActiveSensor class to store active sensor data.",
         "properties": {
            "sensor": {
               "$ref": "#/$defs/Sensor"
            },
            "device": {
               "$ref": "#/$defs/PatientDevice"
            }
         },
         "required": [
            "sensor",
            "device"
         ],
         "title": "ActiveSensor",
         "type": "object"
      },
      "AlarmRules": {
         "description": "AlarmRules class to store alarm rules data.",
         "properties": {
            "c": {
               "default": false,
               "title": "C",
               "type": "boolean"
            },
            "h": {
               "$ref": "#/$defs/H"
            },
            "f": {
               "$ref": "#/$defs/F"
            },
            "l": {
               "$ref": "#/$defs/L"
            },
            "nd": {
               "$ref": "#/$defs/Nd"
            },
            "p": {
               "default": 0,
               "title": "P",
               "type": "integer"
            },
            "r": {
               "default": 0,
               "title": "R",
               "type": "integer"
            },
            "std": {
               "$ref": "#/$defs/Std"
            }
         },
         "required": [
            "h",
            "f",
            "l",
            "nd",
            "std"
         ],
         "title": "AlarmRules",
         "type": "object"
      },
      "Connection": {
         "description": "Connection class to store connection data.",
         "properties": {
            "id": {
               "format": "uuid",
               "title": "Id",
               "type": "string"
            },
            "patientId": {
               "format": "uuid",
               "title": "Patientid",
               "type": "string"
            },
            "country": {
               "default": "",
               "title": "Country",
               "type": "string"
            },
            "status": {
               "default": 0,
               "title": "Status",
               "type": "integer"
            },
            "firstName": {
               "default": "",
               "title": "Firstname",
               "type": "string"
            },
            "lastName": {
               "default": "",
               "title": "Lastname",
               "type": "string"
            },
            "targetLow": {
               "default": 0,
               "title": "Targetlow",
               "type": "integer"
            },
            "targetHigh": {
               "default": 0,
               "title": "Targethigh",
               "type": "integer"
            },
            "uom": {
               "default": 0,
               "title": "Uom",
               "type": "integer"
            },
            "sensor": {
               "$ref": "#/$defs/Sensor"
            },
            "alarmRules": {
               "$ref": "#/$defs/AlarmRules"
            },
            "glucoseMeasurement": {
               "$ref": "#/$defs/GlucoseMeasurementWithTrend"
            },
            "glucoseItem": {
               "$ref": "#/$defs/GlucoseMeasurement"
            },
            "glucoseAlarm": {
               "title": "Glucosealarm",
               "type": "null"
            },
            "patientDevice": {
               "$ref": "#/$defs/PatientDevice"
            },
            "created": {
               "default": 0,
               "title": "Created",
               "type": "integer"
            }
         },
         "required": [
            "id",
            "patientId",
            "sensor",
            "alarmRules",
            "glucoseMeasurement",
            "glucoseItem",
            "glucoseAlarm",
            "patientDevice"
         ],
         "title": "Connection",
         "type": "object"
      },
      "Data": {
         "description": "Data class to store connection data.",
         "properties": {
            "connection": {
               "$ref": "#/$defs/Connection"
            },
            "activeSensors": {
               "items": {
                  "$ref": "#/$defs/ActiveSensor"
               },
               "title": "Activesensors",
               "type": "array"
            },
            "graphData": {
               "items": {
                  "$ref": "#/$defs/GlucoseMeasurement"
               },
               "title": "Graphdata",
               "type": "array"
            }
         },
         "required": [
            "connection",
            "activeSensors",
            "graphData"
         ],
         "title": "Data",
         "type": "object"
      },
      "F": {
         "description": "F class to store F data.",
         "properties": {
            "th": {
               "default": 0,
               "title": "Th",
               "type": "integer"
            },
            "thmm": {
               "default": 0.0,
               "title": "Thmm",
               "type": "number"
            },
            "d": {
               "default": 0,
               "title": "D",
               "type": "integer"
            },
            "tl": {
               "default": 0,
               "title": "Tl",
               "type": "integer"
            },
            "tlmm": {
               "default": 0.0,
               "title": "Tlmm",
               "type": "number"
            }
         },
         "title": "F",
         "type": "object"
      },
      "FixedLowAlarmValues": {
         "description": "FixedLowAlarmValues class to store fixed alarm values.",
         "properties": {
            "mgdl": {
               "default": 0,
               "title": "Mgdl",
               "type": "integer"
            },
            "mmoll": {
               "default": 0.0,
               "title": "Mmoll",
               "type": "number"
            }
         },
         "title": "FixedLowAlarmValues",
         "type": "object"
      },
      "GlucoseMeasurement": {
         "description": "GlucoseMeasurement class to store glucose measurement data.",
         "properties": {
            "FactoryTimestamp": {
               "format": "date-time",
               "title": "Factorytimestamp",
               "type": "string"
            },
            "Timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            },
            "Type": {
               "default": 0,
               "title": "Type",
               "type": "integer"
            },
            "ValueInMgPerDl": {
               "default": 0.0,
               "title": "Valueinmgperdl",
               "type": "number"
            },
            "MeasurementColor": {
               "default": 0,
               "title": "Measurementcolor",
               "type": "integer"
            },
            "GlucoseUnits": {
               "default": 0,
               "title": "Glucoseunits",
               "type": "integer"
            },
            "Value": {
               "default": 0.0,
               "title": "Value",
               "type": "number"
            },
            "isHigh": {
               "title": "Ishigh",
               "type": "boolean"
            },
            "isLow": {
               "title": "Islow",
               "type": "boolean"
            }
         },
         "required": [
            "FactoryTimestamp",
            "Timestamp",
            "isHigh",
            "isLow"
         ],
         "title": "GlucoseMeasurement",
         "type": "object"
      },
      "GlucoseMeasurementWithTrend": {
         "properties": {
            "FactoryTimestamp": {
               "format": "date-time",
               "title": "Factorytimestamp",
               "type": "string"
            },
            "Timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            },
            "Type": {
               "default": 0,
               "title": "Type",
               "type": "integer"
            },
            "ValueInMgPerDl": {
               "default": 0.0,
               "title": "Valueinmgperdl",
               "type": "number"
            },
            "MeasurementColor": {
               "default": 0,
               "title": "Measurementcolor",
               "type": "integer"
            },
            "GlucoseUnits": {
               "default": 0,
               "title": "Glucoseunits",
               "type": "integer"
            },
            "Value": {
               "default": 0.0,
               "title": "Value",
               "type": "number"
            },
            "isHigh": {
               "title": "Ishigh",
               "type": "boolean"
            },
            "isLow": {
               "title": "Islow",
               "type": "boolean"
            },
            "TrendArrow": {
               "$ref": "#/$defs/Trend",
               "default": 3
            }
         },
         "required": [
            "FactoryTimestamp",
            "Timestamp",
            "isHigh",
            "isLow"
         ],
         "title": "GlucoseMeasurementWithTrend",
         "type": "object"
      },
      "H": {
         "description": "H class to store H data.",
         "properties": {
            "th": {
               "default": 0,
               "title": "Th",
               "type": "integer"
            },
            "thmm": {
               "default": 0.0,
               "title": "Thmm",
               "type": "number"
            },
            "d": {
               "default": 0,
               "title": "D",
               "type": "integer"
            },
            "f": {
               "default": 0.0,
               "title": "F",
               "type": "number"
            }
         },
         "title": "H",
         "type": "object"
      },
      "L": {
         "description": "L class to store L data.",
         "properties": {
            "th": {
               "default": 0,
               "title": "Th",
               "type": "integer"
            },
            "thmm": {
               "default": 0.0,
               "title": "Thmm",
               "type": "number"
            },
            "d": {
               "default": 0,
               "title": "D",
               "type": "integer"
            },
            "tl": {
               "default": 0,
               "title": "Tl",
               "type": "integer"
            },
            "tlmm": {
               "default": 0.0,
               "title": "Tlmm",
               "type": "number"
            }
         },
         "title": "L",
         "type": "object"
      },
      "Nd": {
         "description": "Nd class to store Nd data.",
         "properties": {
            "i": {
               "default": 0,
               "title": "I",
               "type": "integer"
            },
            "r": {
               "default": 0,
               "title": "R",
               "type": "integer"
            },
            "l": {
               "default": 0,
               "title": "L",
               "type": "integer"
            }
         },
         "title": "Nd",
         "type": "object"
      },
      "PatientDevice": {
         "description": "PatientDevice class to store device data.",
         "properties": {
            "did": {
               "default": "",
               "title": "Did",
               "type": "string"
            },
            "dtid": {
               "default": 0,
               "title": "Dtid",
               "type": "integer"
            },
            "v": {
               "default": "",
               "title": "V",
               "type": "string"
            },
            "ll": {
               "default": 0,
               "title": "Ll",
               "type": "integer"
            },
            "hl": {
               "default": 0,
               "title": "Hl",
               "type": "integer"
            },
            "u": {
               "default": 0,
               "title": "U",
               "type": "integer"
            },
            "fixedLowAlarmValues": {
               "$ref": "#/$defs/FixedLowAlarmValues"
            },
            "alarms": {
               "default": false,
               "title": "Alarms",
               "type": "boolean"
            }
         },
         "required": [
            "fixedLowAlarmValues"
         ],
         "title": "PatientDevice",
         "type": "object"
      },
      "Sensor": {
         "description": "Sensor class to store sensor data.",
         "properties": {
            "deviceId": {
               "default": "",
               "title": "Deviceid",
               "type": "string"
            },
            "sn": {
               "default": "",
               "title": "Sn",
               "type": "string"
            },
            "a": {
               "default": 0,
               "title": "A",
               "type": "integer"
            },
            "w": {
               "default": 0,
               "title": "W",
               "type": "integer"
            },
            "pt": {
               "default": 0,
               "title": "Pt",
               "type": "integer"
            }
         },
         "title": "Sensor",
         "type": "object"
      },
      "Std": {
         "description": "Std class to store Std data.",
         "properties": {
            "sd": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Sd"
            }
         },
         "title": "Std",
         "type": "object"
      },
      "Ticket": {
         "description": "TicketData class to store ticket data.",
         "properties": {
            "token": {
               "default": "",
               "title": "Token",
               "type": "string"
            },
            "expires": {
               "default": 0,
               "title": "Expires",
               "type": "integer"
            },
            "duration": {
               "default": 0,
               "title": "Duration",
               "type": "integer"
            }
         },
         "title": "Ticket",
         "type": "object"
      },
      "Trend": {
         "enum": [
            1,
            2,
            3,
            4,
            5
         ],
         "title": "Trend",
         "type": "integer"
      }
   },
   "required": [
      "ticket",
      "data"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• data (pylibrelinkup.models.connection.Data)

Validators:

field data: Data [Required]

Validated by:

• preprocess_data

• validate_api_response

property current: GlucoseMeasurementWithTrend

Returns the current glucose measurement.

property history: list[GlucoseMeasurement]

Returns the historical glucose measurements.

pydantic model pylibrelinkup.models.connection.LogbookResponse

Bases: APIResponse

LogbookResponse class to store API logbook data endpoint response.

Show JSON schema

{
   "title": "LogbookResponse",
   "description": "LogbookResponse class to store API logbook data endpoint response.",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "ticket": {
         "$ref": "#/$defs/Ticket"
      },
      "data": {
         "items": {
            "$ref": "#/$defs/GlucoseMeasurement"
         },
         "title": "Data",
         "type": "array"
      }
   },
   "$defs": {
      "GlucoseMeasurement": {
         "description": "GlucoseMeasurement class to store glucose measurement data.",
         "properties": {
            "FactoryTimestamp": {
               "format": "date-time",
               "title": "Factorytimestamp",
               "type": "string"
            },
            "Timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            },
            "Type": {
               "default": 0,
               "title": "Type",
               "type": "integer"
            },
            "ValueInMgPerDl": {
               "default": 0.0,
               "title": "Valueinmgperdl",
               "type": "number"
            },
            "MeasurementColor": {
               "default": 0,
               "title": "Measurementcolor",
               "type": "integer"
            },
            "GlucoseUnits": {
               "default": 0,
               "title": "Glucoseunits",
               "type": "integer"
            },
            "Value": {
               "default": 0.0,
               "title": "Value",
               "type": "number"
            },
            "isHigh": {
               "title": "Ishigh",
               "type": "boolean"
            },
            "isLow": {
               "title": "Islow",
               "type": "boolean"
            }
         },
         "required": [
            "FactoryTimestamp",
            "Timestamp",
            "isHigh",
            "isLow"
         ],
         "title": "GlucoseMeasurement",
         "type": "object"
      },
      "Ticket": {
         "description": "TicketData class to store ticket data.",
         "properties": {
            "token": {
               "default": "",
               "title": "Token",
               "type": "string"
            },
            "expires": {
               "default": 0,
               "title": "Expires",
               "type": "integer"
            },
            "duration": {
               "default": 0,
               "title": "Duration",
               "type": "integer"
            }
         },
         "title": "Ticket",
         "type": "object"
      }
   },
   "required": [
      "ticket",
      "data"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• data (list[pylibrelinkup.models.data.GlucoseMeasurement])

Validators:

field data: list[GlucoseMeasurement] [Required]

Validated by:

• preprocess_data

• validate_api_response

property raw

Returns the raw JSON data returned by the API.

Data

pydantic model pylibrelinkup.models.data.F

Bases: ConfigBaseModel

F class to store F data.

Show JSON schema

{
   "title": "F",
   "description": "F class to store F data.",
   "type": "object",
   "properties": {
      "th": {
         "default": 0,
         "title": "Th",
         "type": "integer"
      },
      "thmm": {
         "default": 0.0,
         "title": "Thmm",
         "type": "number"
      },
      "d": {
         "default": 0,
         "title": "D",
         "type": "integer"
      },
      "tl": {
         "default": 0,
         "title": "Tl",
         "type": "integer"
      },
      "tlmm": {
         "default": 0.0,
         "title": "Tlmm",
         "type": "number"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• d (int)

• th (int)

• thmm (float)

• tl (int)

• tlmm (float)

Validators:

field d: int = 0

Validated by:

• preprocess_data

field th: int = 0

Validated by:

• preprocess_data

field thmm: float = 0.0

Validated by:

• preprocess_data

field tl: int = 0

Validated by:

• preprocess_data

field tlmm: float = 0.0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.data.GlucoseMeasurement

Bases: ConfigBaseModel

GlucoseMeasurement class to store glucose measurement data.

Show JSON schema

{
   "title": "GlucoseMeasurement",
   "description": "GlucoseMeasurement class to store glucose measurement data.",
   "type": "object",
   "properties": {
      "FactoryTimestamp": {
         "format": "date-time",
         "title": "Factorytimestamp",
         "type": "string"
      },
      "Timestamp": {
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      },
      "Type": {
         "default": 0,
         "title": "Type",
         "type": "integer"
      },
      "ValueInMgPerDl": {
         "default": 0.0,
         "title": "Valueinmgperdl",
         "type": "number"
      },
      "MeasurementColor": {
         "default": 0,
         "title": "Measurementcolor",
         "type": "integer"
      },
      "GlucoseUnits": {
         "default": 0,
         "title": "Glucoseunits",
         "type": "integer"
      },
      "Value": {
         "default": 0.0,
         "title": "Value",
         "type": "number"
      },
      "isHigh": {
         "title": "Ishigh",
         "type": "boolean"
      },
      "isLow": {
         "title": "Islow",
         "type": "boolean"
      }
   },
   "required": [
      "FactoryTimestamp",
      "Timestamp",
      "isHigh",
      "isLow"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_pascal at 0x7701ee8bc4a0>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• factory_timestamp (datetime.datetime)

• glucose_units (int)

• is_high (bool)

• is_low (bool)

• measurement_color (int)

• timestamp (datetime.datetime)

• type (int)

• value (float)

• value_in_mg_per_dl (float)

Validators:

• parse_timestamp » factory_timestamp

• parse_timestamp » timestamp

field factory_timestamp: datetime [Required] (alias 'FactoryTimestamp')

Validated by:

• parse_timestamp

• preprocess_data

field glucose_units: int = 0 (alias 'GlucoseUnits')

Validated by:

• preprocess_data

field is_high: bool [Required] (alias 'isHigh')

Validated by:

• preprocess_data

field is_low: bool [Required] (alias 'isLow')

Validated by:

• preprocess_data

field measurement_color: int = 0 (alias 'MeasurementColor')

Validated by:

• preprocess_data

field timestamp: datetime [Required] (alias 'Timestamp')

Validated by:

• parse_timestamp

• preprocess_data

field type: int = 0 (alias 'Type')

Validated by:

• preprocess_data

field value: float = 0.0 (alias 'Value')

Validated by:

• preprocess_data

field value_in_mg_per_dl: float = 0.0 (alias 'ValueInMgPerDl')

Validated by:

• preprocess_data

validator parse_timestamp  »  factory_timestamp, timestamp

pydantic model pylibrelinkup.models.data.GlucoseMeasurementWithTrend

Bases: GlucoseMeasurement

Show JSON schema

{
   "title": "GlucoseMeasurementWithTrend",
   "type": "object",
   "properties": {
      "FactoryTimestamp": {
         "format": "date-time",
         "title": "Factorytimestamp",
         "type": "string"
      },
      "Timestamp": {
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      },
      "Type": {
         "default": 0,
         "title": "Type",
         "type": "integer"
      },
      "ValueInMgPerDl": {
         "default": 0.0,
         "title": "Valueinmgperdl",
         "type": "number"
      },
      "MeasurementColor": {
         "default": 0,
         "title": "Measurementcolor",
         "type": "integer"
      },
      "GlucoseUnits": {
         "default": 0,
         "title": "Glucoseunits",
         "type": "integer"
      },
      "Value": {
         "default": 0.0,
         "title": "Value",
         "type": "number"
      },
      "isHigh": {
         "title": "Ishigh",
         "type": "boolean"
      },
      "isLow": {
         "title": "Islow",
         "type": "boolean"
      },
      "TrendArrow": {
         "$ref": "#/$defs/Trend",
         "default": 3
      }
   },
   "$defs": {
      "Trend": {
         "enum": [
            1,
            2,
            3,
            4,
            5
         ],
         "title": "Trend",
         "type": "integer"
      }
   },
   "required": [
      "FactoryTimestamp",
      "Timestamp",
      "isHigh",
      "isLow"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_pascal at 0x7701ee8bc4a0>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• trend (pylibrelinkup.models.data.Trend)

Validators:

field trend: Trend = Trend.STABLE (alias 'TrendArrow')

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.data.H

Bases: ConfigBaseModel

H class to store H data.

Show JSON schema

{
   "title": "H",
   "description": "H class to store H data.",
   "type": "object",
   "properties": {
      "th": {
         "default": 0,
         "title": "Th",
         "type": "integer"
      },
      "thmm": {
         "default": 0.0,
         "title": "Thmm",
         "type": "number"
      },
      "d": {
         "default": 0,
         "title": "D",
         "type": "integer"
      },
      "f": {
         "default": 0.0,
         "title": "F",
         "type": "number"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• d (int)

• f (float)

• th (int)

• thmm (float)

Validators:

field d: int = 0

Validated by:

• preprocess_data

field f: float = 0.0

Validated by:

• preprocess_data

field th: int = 0

Validated by:

• preprocess_data

field thmm: float = 0.0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.data.L

Bases: ConfigBaseModel

L class to store L data.

Show JSON schema

{
   "title": "L",
   "description": "L class to store L data.",
   "type": "object",
   "properties": {
      "th": {
         "default": 0,
         "title": "Th",
         "type": "integer"
      },
      "thmm": {
         "default": 0.0,
         "title": "Thmm",
         "type": "number"
      },
      "d": {
         "default": 0,
         "title": "D",
         "type": "integer"
      },
      "tl": {
         "default": 0,
         "title": "Tl",
         "type": "integer"
      },
      "tlmm": {
         "default": 0.0,
         "title": "Tlmm",
         "type": "number"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• d (int)

• th (int)

• thmm (float)

• tl (int)

• tlmm (float)

Validators:

field d: int = 0

Validated by:

• preprocess_data

field th: int = 0

Validated by:

• preprocess_data

field thmm: float = 0.0

Validated by:

• preprocess_data

field tl: int = 0

Validated by:

• preprocess_data

field tlmm: float = 0.0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.data.Nd

Bases: ConfigBaseModel

Nd class to store Nd data.

Show JSON schema

{
   "title": "Nd",
   "description": "Nd class to store Nd data.",
   "type": "object",
   "properties": {
      "i": {
         "default": 0,
         "title": "I",
         "type": "integer"
      },
      "r": {
         "default": 0,
         "title": "R",
         "type": "integer"
      },
      "l": {
         "default": 0,
         "title": "L",
         "type": "integer"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• i (int)

• l (int)

• r (int)

Validators:

field i: int = 0

Validated by:

• preprocess_data

field l: int = 0

Validated by:

• preprocess_data

field r: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.data.Patient

Bases: ConfigBaseModel

Patient class to store patient data.

Show JSON schema

{
   "title": "Patient",
   "description": "Patient class to store patient data.",
   "type": "object",
   "properties": {
      "id": {
         "format": "uuid",
         "title": "Id",
         "type": "string"
      },
      "patientId": {
         "format": "uuid",
         "title": "Patientid",
         "type": "string"
      },
      "firstName": {
         "title": "Firstname",
         "type": "string"
      },
      "lastName": {
         "title": "Lastname",
         "type": "string"
      }
   },
   "required": [
      "id",
      "patientId",
      "firstName",
      "lastName"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• first_name (str)

• id (uuid.UUID)

• last_name (str)

• patient_id (uuid.UUID)

Validators:

field first_name: str [Required] (alias 'firstName')

Validated by:

• preprocess_data

field id: UUID [Required]

Validated by:

• preprocess_data

field last_name: str [Required] (alias 'lastName')

Validated by:

• preprocess_data

field patient_id: UUID [Required] (alias 'patientId')

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.data.Std

Bases: ConfigBaseModel

Std class to store Std data.

Show JSON schema

{
   "title": "Std",
   "description": "Std class to store Std data.",
   "type": "object",
   "properties": {
      "sd": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Sd"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• sd (bool | None)

Validators:

field sd: bool | None = None

Validated by:

• preprocess_data

enum pylibrelinkup.models.data.Trend(value)

Bases: IntEnum

Member Type:

int

Valid values are as follows:

DOWN_FAST = <Trend.DOWN_FAST: 1>

DOWN_SLOW = <Trend.DOWN_SLOW: 2>

STABLE = <Trend.STABLE: 3>

UP_SLOW = <Trend.UP_SLOW: 4>

UP_FAST = <Trend.UP_FAST: 5>

The Enum and its members also have the following methods:

property indicator: str

Hardware

pydantic model pylibrelinkup.models.hardware.ActiveSensor

Bases: ConfigBaseModel

ActiveSensor class to store active sensor data.

Show JSON schema

{
   "title": "ActiveSensor",
   "description": "ActiveSensor class to store active sensor data.",
   "type": "object",
   "properties": {
      "sensor": {
         "$ref": "#/$defs/Sensor"
      },
      "device": {
         "$ref": "#/$defs/PatientDevice"
      }
   },
   "$defs": {
      "FixedLowAlarmValues": {
         "description": "FixedLowAlarmValues class to store fixed alarm values.",
         "properties": {
            "mgdl": {
               "default": 0,
               "title": "Mgdl",
               "type": "integer"
            },
            "mmoll": {
               "default": 0.0,
               "title": "Mmoll",
               "type": "number"
            }
         },
         "title": "FixedLowAlarmValues",
         "type": "object"
      },
      "PatientDevice": {
         "description": "PatientDevice class to store device data.",
         "properties": {
            "did": {
               "default": "",
               "title": "Did",
               "type": "string"
            },
            "dtid": {
               "default": 0,
               "title": "Dtid",
               "type": "integer"
            },
            "v": {
               "default": "",
               "title": "V",
               "type": "string"
            },
            "ll": {
               "default": 0,
               "title": "Ll",
               "type": "integer"
            },
            "hl": {
               "default": 0,
               "title": "Hl",
               "type": "integer"
            },
            "u": {
               "default": 0,
               "title": "U",
               "type": "integer"
            },
            "fixedLowAlarmValues": {
               "$ref": "#/$defs/FixedLowAlarmValues"
            },
            "alarms": {
               "default": false,
               "title": "Alarms",
               "type": "boolean"
            }
         },
         "required": [
            "fixedLowAlarmValues"
         ],
         "title": "PatientDevice",
         "type": "object"
      },
      "Sensor": {
         "description": "Sensor class to store sensor data.",
         "properties": {
            "deviceId": {
               "default": "",
               "title": "Deviceid",
               "type": "string"
            },
            "sn": {
               "default": "",
               "title": "Sn",
               "type": "string"
            },
            "a": {
               "default": 0,
               "title": "A",
               "type": "integer"
            },
            "w": {
               "default": 0,
               "title": "W",
               "type": "integer"
            },
            "pt": {
               "default": 0,
               "title": "Pt",
               "type": "integer"
            }
         },
         "title": "Sensor",
         "type": "object"
      }
   },
   "required": [
      "sensor",
      "device"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• device (pylibrelinkup.models.hardware.PatientDevice)

• sensor (pylibrelinkup.models.hardware.Sensor)

Validators:

field device: PatientDevice [Required]

Validated by:

• preprocess_data

field sensor: Sensor [Required]

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.hardware.PatientDevice

Bases: ConfigBaseModel

PatientDevice class to store device data.

Show JSON schema

{
   "title": "PatientDevice",
   "description": "PatientDevice class to store device data.",
   "type": "object",
   "properties": {
      "did": {
         "default": "",
         "title": "Did",
         "type": "string"
      },
      "dtid": {
         "default": 0,
         "title": "Dtid",
         "type": "integer"
      },
      "v": {
         "default": "",
         "title": "V",
         "type": "string"
      },
      "ll": {
         "default": 0,
         "title": "Ll",
         "type": "integer"
      },
      "hl": {
         "default": 0,
         "title": "Hl",
         "type": "integer"
      },
      "u": {
         "default": 0,
         "title": "U",
         "type": "integer"
      },
      "fixedLowAlarmValues": {
         "$ref": "#/$defs/FixedLowAlarmValues"
      },
      "alarms": {
         "default": false,
         "title": "Alarms",
         "type": "boolean"
      }
   },
   "$defs": {
      "FixedLowAlarmValues": {
         "description": "FixedLowAlarmValues class to store fixed alarm values.",
         "properties": {
            "mgdl": {
               "default": 0,
               "title": "Mgdl",
               "type": "integer"
            },
            "mmoll": {
               "default": 0.0,
               "title": "Mmoll",
               "type": "number"
            }
         },
         "title": "FixedLowAlarmValues",
         "type": "object"
      }
   },
   "required": [
      "fixedLowAlarmValues"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• alarms (bool)

• did (str)

• dtid (int)

• fixed_low_alarm_values (pylibrelinkup.models.config.FixedLowAlarmValues)

• hl (int)

• ll (int)

• u (int)

• v (str)

Validators:

field alarms: bool = False

Validated by:

• preprocess_data

field did: str = ''

Validated by:

• preprocess_data

field dtid: int = 0

Validated by:

• preprocess_data

field fixed_low_alarm_values: FixedLowAlarmValues [Required] (alias 'fixedLowAlarmValues')

Validated by:

• preprocess_data

field hl: int = 0

Validated by:

• preprocess_data

field ll: int = 0

Validated by:

• preprocess_data

field u: int = 0

Validated by:

• preprocess_data

field v: str = ''

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.hardware.Sensor

Bases: ConfigBaseModel

Sensor class to store sensor data.

Show JSON schema

{
   "title": "Sensor",
   "description": "Sensor class to store sensor data.",
   "type": "object",
   "properties": {
      "deviceId": {
         "default": "",
         "title": "Deviceid",
         "type": "string"
      },
      "sn": {
         "default": "",
         "title": "Sn",
         "type": "string"
      },
      "a": {
         "default": 0,
         "title": "A",
         "type": "integer"
      },
      "w": {
         "default": 0,
         "title": "W",
         "type": "integer"
      },
      "pt": {
         "default": 0,
         "title": "Pt",
         "type": "integer"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• a (int)

• device_id (str)

• pt (int)

• sn (str)

• w (int)

Validators:

field a: int = 0

Validated by:

• preprocess_data

field device_id: str = '' (alias 'deviceId')

Validated by:

• preprocess_data

field pt: int = 0

Validated by:

• preprocess_data

field sn: str = ''

Validated by:

• preprocess_data

field w: int = 0

Validated by:

• preprocess_data

Login

pydantic model pylibrelinkup.models.login.AuthTicket

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "AuthTicket",
   "type": "object",
   "properties": {
      "token": {
         "default": "",
         "title": "Token",
         "type": "string"
      },
      "expires": {
         "default": 0,
         "title": "Expires",
         "type": "integer"
      },
      "duration": {
         "default": 0,
         "title": "Duration",
         "type": "integer"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• duration (int)

• expires (int)

• token (str)

Validators:

field duration: int = 0

Validated by:

• preprocess_data

field expires: int = 0

Validated by:

• preprocess_data

field token: str = ''

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.Consents

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "Consents",
   "type": "object",
   "properties": {
      "llu": {
         "$ref": "#/$defs/Llu",
         "default": {
            "policyAccept": 0,
            "touAccept": 0
         }
      },
      "realWorldEvidence": {
         "$ref": "#/$defs/RealWorldEvidence",
         "default": {
            "policyAccept": 0,
            "declined": false,
            "touAccept": 0,
            "history": []
         }
      }
   },
   "$defs": {
      "HistoryItem": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Declined"
            }
         },
         "title": "HistoryItem",
         "type": "object"
      },
      "Llu": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            }
         },
         "title": "Llu",
         "type": "object"
      },
      "RealWorldEvidence": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "default": false,
               "title": "Declined",
               "type": "boolean"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            },
            "history": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/HistoryItem"
               },
               "title": "History",
               "type": "array"
            }
         },
         "title": "RealWorldEvidence",
         "type": "object"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• llu (pylibrelinkup.models.login.Llu)

• realWorldEvidence (pylibrelinkup.models.login.RealWorldEvidence)

Validators:

field llu: Llu = Llu(policyAccept=0, touAccept=0)

Validated by:

• preprocess_data

field realWorldEvidence: RealWorldEvidence = RealWorldEvidence(policyAccept=0, declined=False, touAccept=0, history=[])

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.Data

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "user": {
         "$ref": "#/$defs/User"
      },
      "messages": {
         "$ref": "#/$defs/DataMessages"
      },
      "notifications": {
         "$ref": "#/$defs/Notifications"
      },
      "authTicket": {
         "$ref": "#/$defs/AuthTicket"
      },
      "invitations": {
         "items": {
            "type": "string"
         },
         "title": "Invitations",
         "type": "array"
      }
   },
   "$defs": {
      "AuthTicket": {
         "properties": {
            "token": {
               "default": "",
               "title": "Token",
               "type": "string"
            },
            "expires": {
               "default": 0,
               "title": "Expires",
               "type": "integer"
            },
            "duration": {
               "default": 0,
               "title": "Duration",
               "type": "integer"
            }
         },
         "title": "AuthTicket",
         "type": "object"
      },
      "Consents": {
         "properties": {
            "llu": {
               "$ref": "#/$defs/Llu",
               "default": {
                  "policyAccept": 0,
                  "touAccept": 0
               }
            },
            "realWorldEvidence": {
               "$ref": "#/$defs/RealWorldEvidence",
               "default": {
                  "policyAccept": 0,
                  "declined": false,
                  "touAccept": 0,
                  "history": []
               }
            }
         },
         "title": "Consents",
         "type": "object"
      },
      "DataMessages": {
         "properties": {
            "unread": {
               "default": 0,
               "title": "Unread",
               "type": "integer"
            }
         },
         "title": "DataMessages",
         "type": "object"
      },
      "HistoryItem": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Declined"
            }
         },
         "title": "HistoryItem",
         "type": "object"
      },
      "Llu": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            }
         },
         "title": "Llu",
         "type": "object"
      },
      "Notifications": {
         "properties": {
            "unresolved": {
               "default": 0,
               "title": "Unresolved",
               "type": "integer"
            }
         },
         "title": "Notifications",
         "type": "object"
      },
      "RealWorldEvidence": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "default": false,
               "title": "Declined",
               "type": "boolean"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            },
            "history": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/HistoryItem"
               },
               "title": "History",
               "type": "array"
            }
         },
         "title": "RealWorldEvidence",
         "type": "object"
      },
      "System": {
         "properties": {
            "messages": {
               "$ref": "#/$defs/SystemMessages"
            }
         },
         "required": [
            "messages"
         ],
         "title": "System",
         "type": "object"
      },
      "SystemMessages": {
         "properties": {
            "firstUsePhoenix": {
               "default": 0,
               "title": "Firstusephoenix",
               "type": "integer"
            },
            "firstUsePhoenixReportsDataMerged": {
               "default": 0,
               "title": "Firstusephoenixreportsdatamerged",
               "type": "integer"
            },
            "lluGettingStartedBanner": {
               "default": 0,
               "title": "Llugettingstartedbanner",
               "type": "integer"
            },
            "lluNewFeatureModal": {
               "default": 0,
               "title": "Llunewfeaturemodal",
               "type": "integer"
            },
            "lluOnboarding": {
               "default": 0,
               "title": "Lluonboarding",
               "type": "integer"
            },
            "lvWebPostRelease": {
               "default": "",
               "title": "Lvwebpostrelease",
               "type": "string"
            }
         },
         "title": "SystemMessages",
         "type": "object"
      },
      "User": {
         "properties": {
            "id": {
               "default": "",
               "title": "Id",
               "type": "string"
            },
            "firstName": {
               "default": "",
               "title": "Firstname",
               "type": "string"
            },
            "lastName": {
               "default": "",
               "title": "Lastname",
               "type": "string"
            },
            "email": {
               "default": "",
               "title": "Email",
               "type": "string"
            },
            "country": {
               "default": "",
               "title": "Country",
               "type": "string"
            },
            "uiLanguage": {
               "default": "",
               "title": "Uilanguage",
               "type": "string"
            },
            "communicationLanguage": {
               "default": "",
               "title": "Communicationlanguage",
               "type": "string"
            },
            "accountType": {
               "default": "",
               "title": "Accounttype",
               "type": "string"
            },
            "uom": {
               "default": "",
               "title": "Uom",
               "type": "string"
            },
            "dateFormat": {
               "default": "",
               "title": "Dateformat",
               "type": "string"
            },
            "timeFormat": {
               "default": "",
               "title": "Timeformat",
               "type": "string"
            },
            "emailDay": {
               "items": {
                  "type": "integer"
               },
               "title": "Emailday",
               "type": "array"
            },
            "system": {
               "$ref": "#/$defs/System"
            },
            "details": {
               "additionalProperties": true,
               "title": "Details",
               "type": "object"
            },
            "created": {
               "title": "Created",
               "type": "integer"
            },
            "lastLogin": {
               "title": "Lastlogin",
               "type": "integer"
            },
            "programs": {
               "additionalProperties": true,
               "title": "Programs",
               "type": "object"
            },
            "dateOfBirth": {
               "title": "Dateofbirth",
               "type": "integer"
            },
            "practices": {
               "additionalProperties": true,
               "title": "Practices",
               "type": "object"
            },
            "devices": {
               "additionalProperties": true,
               "title": "Devices",
               "type": "object"
            },
            "consents": {
               "$ref": "#/$defs/Consents"
            }
         },
         "required": [
            "emailDay",
            "system",
            "details",
            "created",
            "lastLogin",
            "programs",
            "dateOfBirth",
            "practices",
            "devices",
            "consents"
         ],
         "title": "User",
         "type": "object"
      }
   },
   "required": [
      "user",
      "messages",
      "notifications",
      "authTicket",
      "invitations"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• authTicket (pylibrelinkup.models.login.AuthTicket)

• invitations (List[str])

• messages (pylibrelinkup.models.login.DataMessages)

• notifications (pylibrelinkup.models.login.Notifications)

• user (pylibrelinkup.models.login.User)

Validators:

field authTicket: AuthTicket [Required]

Validated by:

• preprocess_data

field invitations: List[str] [Required]

Validated by:

• preprocess_data

field messages: DataMessages [Required]

Validated by:

• preprocess_data

field notifications: Notifications [Required]

Validated by:

• preprocess_data

field user: User [Required]

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.DataMessages

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "DataMessages",
   "type": "object",
   "properties": {
      "unread": {
         "default": 0,
         "title": "Unread",
         "type": "integer"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• unread (int)

Validators:

field unread: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.ErrorMessage

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "ErrorMessage",
   "type": "object",
   "properties": {
      "message": {
         "default": "",
         "title": "Message",
         "type": "string"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• message (str)

Validators:

field message: str = ''

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.Llu

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "Llu",
   "type": "object",
   "properties": {
      "policyAccept": {
         "default": 0,
         "title": "Policyaccept",
         "type": "integer"
      },
      "touAccept": {
         "default": 0,
         "title": "Touaccept",
         "type": "integer"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• policyAccept (int)

• touAccept (int)

Validators:

field policyAccept: int = 0

Validated by:

• preprocess_data

field touAccept: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.LoginArgs

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "LoginArgs",
   "type": "object",
   "properties": {
      "email": {
         "default": "",
         "title": "Email",
         "type": "string"
      },
      "password": {
         "default": "",
         "title": "Password",
         "type": "string"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• email (str)

• password (str)

Validators:

field email: str = ''

Validated by:

• preprocess_data

field password: str = ''

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.LoginRedirectData

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "LoginRedirectData",
   "type": "object",
   "properties": {
      "redirect": {
         "default": false,
         "title": "Redirect",
         "type": "boolean"
      },
      "region": {
         "default": "",
         "title": "Region",
         "type": "string"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• redirect (bool)

• region (str)

Validators:

field redirect: bool = False

Validated by:

• preprocess_data

field region: str = ''

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.LoginRedirectResponse

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "LoginRedirectResponse",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "data": {
         "$ref": "#/$defs/LoginRedirectData"
      }
   },
   "$defs": {
      "LoginRedirectData": {
         "properties": {
            "redirect": {
               "default": false,
               "title": "Redirect",
               "type": "boolean"
            },
            "region": {
               "default": "",
               "title": "Region",
               "type": "string"
            }
         },
         "title": "LoginRedirectData",
         "type": "object"
      }
   },
   "required": [
      "data"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• data (pylibrelinkup.models.login.LoginRedirectData)

• status (int)

Validators:

field data: LoginRedirectData [Required]

Validated by:

• preprocess_data

field status: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.LoginResponse

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "LoginResponse",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "data": {
         "$ref": "#/$defs/Data"
      }
   },
   "$defs": {
      "AuthTicket": {
         "properties": {
            "token": {
               "default": "",
               "title": "Token",
               "type": "string"
            },
            "expires": {
               "default": 0,
               "title": "Expires",
               "type": "integer"
            },
            "duration": {
               "default": 0,
               "title": "Duration",
               "type": "integer"
            }
         },
         "title": "AuthTicket",
         "type": "object"
      },
      "Consents": {
         "properties": {
            "llu": {
               "$ref": "#/$defs/Llu",
               "default": {
                  "policyAccept": 0,
                  "touAccept": 0
               }
            },
            "realWorldEvidence": {
               "$ref": "#/$defs/RealWorldEvidence",
               "default": {
                  "policyAccept": 0,
                  "declined": false,
                  "touAccept": 0,
                  "history": []
               }
            }
         },
         "title": "Consents",
         "type": "object"
      },
      "Data": {
         "properties": {
            "user": {
               "$ref": "#/$defs/User"
            },
            "messages": {
               "$ref": "#/$defs/DataMessages"
            },
            "notifications": {
               "$ref": "#/$defs/Notifications"
            },
            "authTicket": {
               "$ref": "#/$defs/AuthTicket"
            },
            "invitations": {
               "items": {
                  "type": "string"
               },
               "title": "Invitations",
               "type": "array"
            }
         },
         "required": [
            "user",
            "messages",
            "notifications",
            "authTicket",
            "invitations"
         ],
         "title": "Data",
         "type": "object"
      },
      "DataMessages": {
         "properties": {
            "unread": {
               "default": 0,
               "title": "Unread",
               "type": "integer"
            }
         },
         "title": "DataMessages",
         "type": "object"
      },
      "HistoryItem": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Declined"
            }
         },
         "title": "HistoryItem",
         "type": "object"
      },
      "Llu": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            }
         },
         "title": "Llu",
         "type": "object"
      },
      "Notifications": {
         "properties": {
            "unresolved": {
               "default": 0,
               "title": "Unresolved",
               "type": "integer"
            }
         },
         "title": "Notifications",
         "type": "object"
      },
      "RealWorldEvidence": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "default": false,
               "title": "Declined",
               "type": "boolean"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            },
            "history": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/HistoryItem"
               },
               "title": "History",
               "type": "array"
            }
         },
         "title": "RealWorldEvidence",
         "type": "object"
      },
      "System": {
         "properties": {
            "messages": {
               "$ref": "#/$defs/SystemMessages"
            }
         },
         "required": [
            "messages"
         ],
         "title": "System",
         "type": "object"
      },
      "SystemMessages": {
         "properties": {
            "firstUsePhoenix": {
               "default": 0,
               "title": "Firstusephoenix",
               "type": "integer"
            },
            "firstUsePhoenixReportsDataMerged": {
               "default": 0,
               "title": "Firstusephoenixreportsdatamerged",
               "type": "integer"
            },
            "lluGettingStartedBanner": {
               "default": 0,
               "title": "Llugettingstartedbanner",
               "type": "integer"
            },
            "lluNewFeatureModal": {
               "default": 0,
               "title": "Llunewfeaturemodal",
               "type": "integer"
            },
            "lluOnboarding": {
               "default": 0,
               "title": "Lluonboarding",
               "type": "integer"
            },
            "lvWebPostRelease": {
               "default": "",
               "title": "Lvwebpostrelease",
               "type": "string"
            }
         },
         "title": "SystemMessages",
         "type": "object"
      },
      "User": {
         "properties": {
            "id": {
               "default": "",
               "title": "Id",
               "type": "string"
            },
            "firstName": {
               "default": "",
               "title": "Firstname",
               "type": "string"
            },
            "lastName": {
               "default": "",
               "title": "Lastname",
               "type": "string"
            },
            "email": {
               "default": "",
               "title": "Email",
               "type": "string"
            },
            "country": {
               "default": "",
               "title": "Country",
               "type": "string"
            },
            "uiLanguage": {
               "default": "",
               "title": "Uilanguage",
               "type": "string"
            },
            "communicationLanguage": {
               "default": "",
               "title": "Communicationlanguage",
               "type": "string"
            },
            "accountType": {
               "default": "",
               "title": "Accounttype",
               "type": "string"
            },
            "uom": {
               "default": "",
               "title": "Uom",
               "type": "string"
            },
            "dateFormat": {
               "default": "",
               "title": "Dateformat",
               "type": "string"
            },
            "timeFormat": {
               "default": "",
               "title": "Timeformat",
               "type": "string"
            },
            "emailDay": {
               "items": {
                  "type": "integer"
               },
               "title": "Emailday",
               "type": "array"
            },
            "system": {
               "$ref": "#/$defs/System"
            },
            "details": {
               "additionalProperties": true,
               "title": "Details",
               "type": "object"
            },
            "created": {
               "title": "Created",
               "type": "integer"
            },
            "lastLogin": {
               "title": "Lastlogin",
               "type": "integer"
            },
            "programs": {
               "additionalProperties": true,
               "title": "Programs",
               "type": "object"
            },
            "dateOfBirth": {
               "title": "Dateofbirth",
               "type": "integer"
            },
            "practices": {
               "additionalProperties": true,
               "title": "Practices",
               "type": "object"
            },
            "devices": {
               "additionalProperties": true,
               "title": "Devices",
               "type": "object"
            },
            "consents": {
               "$ref": "#/$defs/Consents"
            }
         },
         "required": [
            "emailDay",
            "system",
            "details",
            "created",
            "lastLogin",
            "programs",
            "dateOfBirth",
            "practices",
            "devices",
            "consents"
         ],
         "title": "User",
         "type": "object"
      }
   },
   "required": [
      "data"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• data (pylibrelinkup.models.login.Data)

• status (int)

Validators:

field data: Data [Required]

Validated by:

• preprocess_data

field status: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.LoginResponseUnauthenticated

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "LoginResponseUnauthenticated",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "error": {
         "$ref": "#/$defs/ErrorMessage"
      }
   },
   "$defs": {
      "ErrorMessage": {
         "properties": {
            "message": {
               "default": "",
               "title": "Message",
               "type": "string"
            }
         },
         "title": "ErrorMessage",
         "type": "object"
      }
   },
   "required": [
      "error"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• error (pylibrelinkup.models.login.ErrorMessage)

• status (int)

Validators:

field error: ErrorMessage [Required]

Validated by:

• preprocess_data

field status: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.Notifications

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "Notifications",
   "type": "object",
   "properties": {
      "unresolved": {
         "default": 0,
         "title": "Unresolved",
         "type": "integer"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• unresolved (int)

Validators:

field unresolved: int = 0

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.System

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "System",
   "type": "object",
   "properties": {
      "messages": {
         "$ref": "#/$defs/SystemMessages"
      }
   },
   "$defs": {
      "SystemMessages": {
         "properties": {
            "firstUsePhoenix": {
               "default": 0,
               "title": "Firstusephoenix",
               "type": "integer"
            },
            "firstUsePhoenixReportsDataMerged": {
               "default": 0,
               "title": "Firstusephoenixreportsdatamerged",
               "type": "integer"
            },
            "lluGettingStartedBanner": {
               "default": 0,
               "title": "Llugettingstartedbanner",
               "type": "integer"
            },
            "lluNewFeatureModal": {
               "default": 0,
               "title": "Llunewfeaturemodal",
               "type": "integer"
            },
            "lluOnboarding": {
               "default": 0,
               "title": "Lluonboarding",
               "type": "integer"
            },
            "lvWebPostRelease": {
               "default": "",
               "title": "Lvwebpostrelease",
               "type": "string"
            }
         },
         "title": "SystemMessages",
         "type": "object"
      }
   },
   "required": [
      "messages"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• messages (pylibrelinkup.models.login.SystemMessages)

Validators:

field messages: SystemMessages [Required]

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.SystemMessages

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "SystemMessages",
   "type": "object",
   "properties": {
      "firstUsePhoenix": {
         "default": 0,
         "title": "Firstusephoenix",
         "type": "integer"
      },
      "firstUsePhoenixReportsDataMerged": {
         "default": 0,
         "title": "Firstusephoenixreportsdatamerged",
         "type": "integer"
      },
      "lluGettingStartedBanner": {
         "default": 0,
         "title": "Llugettingstartedbanner",
         "type": "integer"
      },
      "lluNewFeatureModal": {
         "default": 0,
         "title": "Llunewfeaturemodal",
         "type": "integer"
      },
      "lluOnboarding": {
         "default": 0,
         "title": "Lluonboarding",
         "type": "integer"
      },
      "lvWebPostRelease": {
         "default": "",
         "title": "Lvwebpostrelease",
         "type": "string"
      }
   }
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• firstUsePhoenix (int)

• firstUsePhoenixReportsDataMerged (int)

• lluGettingStartedBanner (int)

• lluNewFeatureModal (int)

• lluOnboarding (int)

• lvWebPostRelease (str)

Validators:

field firstUsePhoenix: int = 0

Validated by:

• preprocess_data

field firstUsePhoenixReportsDataMerged: int = 0

Validated by:

• preprocess_data

field lluGettingStartedBanner: int = 0

Validated by:

• preprocess_data

field lluNewFeatureModal: int = 0

Validated by:

• preprocess_data

field lluOnboarding: int = 0

Validated by:

• preprocess_data

field lvWebPostRelease: str = ''

Validated by:

• preprocess_data

pydantic model pylibrelinkup.models.login.User

Bases: ConfigBaseModel

Show JSON schema

{
   "title": "User",
   "type": "object",
   "properties": {
      "id": {
         "default": "",
         "title": "Id",
         "type": "string"
      },
      "firstName": {
         "default": "",
         "title": "Firstname",
         "type": "string"
      },
      "lastName": {
         "default": "",
         "title": "Lastname",
         "type": "string"
      },
      "email": {
         "default": "",
         "title": "Email",
         "type": "string"
      },
      "country": {
         "default": "",
         "title": "Country",
         "type": "string"
      },
      "uiLanguage": {
         "default": "",
         "title": "Uilanguage",
         "type": "string"
      },
      "communicationLanguage": {
         "default": "",
         "title": "Communicationlanguage",
         "type": "string"
      },
      "accountType": {
         "default": "",
         "title": "Accounttype",
         "type": "string"
      },
      "uom": {
         "default": "",
         "title": "Uom",
         "type": "string"
      },
      "dateFormat": {
         "default": "",
         "title": "Dateformat",
         "type": "string"
      },
      "timeFormat": {
         "default": "",
         "title": "Timeformat",
         "type": "string"
      },
      "emailDay": {
         "items": {
            "type": "integer"
         },
         "title": "Emailday",
         "type": "array"
      },
      "system": {
         "$ref": "#/$defs/System"
      },
      "details": {
         "additionalProperties": true,
         "title": "Details",
         "type": "object"
      },
      "created": {
         "title": "Created",
         "type": "integer"
      },
      "lastLogin": {
         "title": "Lastlogin",
         "type": "integer"
      },
      "programs": {
         "additionalProperties": true,
         "title": "Programs",
         "type": "object"
      },
      "dateOfBirth": {
         "title": "Dateofbirth",
         "type": "integer"
      },
      "practices": {
         "additionalProperties": true,
         "title": "Practices",
         "type": "object"
      },
      "devices": {
         "additionalProperties": true,
         "title": "Devices",
         "type": "object"
      },
      "consents": {
         "$ref": "#/$defs/Consents"
      }
   },
   "$defs": {
      "Consents": {
         "properties": {
            "llu": {
               "$ref": "#/$defs/Llu",
               "default": {
                  "policyAccept": 0,
                  "touAccept": 0
               }
            },
            "realWorldEvidence": {
               "$ref": "#/$defs/RealWorldEvidence",
               "default": {
                  "policyAccept": 0,
                  "declined": false,
                  "touAccept": 0,
                  "history": []
               }
            }
         },
         "title": "Consents",
         "type": "object"
      },
      "HistoryItem": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Declined"
            }
         },
         "title": "HistoryItem",
         "type": "object"
      },
      "Llu": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            }
         },
         "title": "Llu",
         "type": "object"
      },
      "RealWorldEvidence": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "default": false,
               "title": "Declined",
               "type": "boolean"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            },
            "history": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/HistoryItem"
               },
               "title": "History",
               "type": "array"
            }
         },
         "title": "RealWorldEvidence",
         "type": "object"
      },
      "System": {
         "properties": {
            "messages": {
               "$ref": "#/$defs/SystemMessages"
            }
         },
         "required": [
            "messages"
         ],
         "title": "System",
         "type": "object"
      },
      "SystemMessages": {
         "properties": {
            "firstUsePhoenix": {
               "default": 0,
               "title": "Firstusephoenix",
               "type": "integer"
            },
            "firstUsePhoenixReportsDataMerged": {
               "default": 0,
               "title": "Firstusephoenixreportsdatamerged",
               "type": "integer"
            },
            "lluGettingStartedBanner": {
               "default": 0,
               "title": "Llugettingstartedbanner",
               "type": "integer"
            },
            "lluNewFeatureModal": {
               "default": 0,
               "title": "Llunewfeaturemodal",
               "type": "integer"
            },
            "lluOnboarding": {
               "default": 0,
               "title": "Lluonboarding",
               "type": "integer"
            },
            "lvWebPostRelease": {
               "default": "",
               "title": "Lvwebpostrelease",
               "type": "string"
            }
         },
         "title": "SystemMessages",
         "type": "object"
      }
   },
   "required": [
      "emailDay",
      "system",
      "details",
      "created",
      "lastLogin",
      "programs",
      "dateOfBirth",
      "practices",
      "devices",
      "consents"
   ]
}

Config:

• str_strip_whitespace: bool = True

• alias_generator: function = <function to_camel at 0x7701ee8bc540>

• populate_by_name: bool = True

• from_attributes: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• accountType (str)

• communicationLanguage (str)

• consents (pylibrelinkup.models.login.Consents)

• country (str)

• created (int)

• dateFormat (str)

• dateOfBirth (int)

• details (dict)

• devices (dict)

• email (str)

• emailDay (List[int])

• firstName (str)

• id (str)

• lastLogin (int)

• lastName (str)

• practices (dict)

• programs (dict)

• system (pylibrelinkup.models.login.System)

• timeFormat (str)

• uiLanguage (str)

• uom (str)

Validators:

field accountType: str = ''

Validated by:

• preprocess_data

field communicationLanguage: str = ''

Validated by:

• preprocess_data

field consents: Consents [Required]

Validated by:

• preprocess_data

field country: str = ''

Validated by:

• preprocess_data

field created: int [Required]

Validated by:

• preprocess_data

field dateFormat: str = ''

Validated by:

• preprocess_data

field dateOfBirth: int [Required]

Validated by:

• preprocess_data

field details: dict [Required]

Validated by:

• preprocess_data

field devices: dict [Required]

Validated by:

• preprocess_data

field email: str = ''

Validated by:

• preprocess_data

field emailDay: List[int] [Required]

Validated by:

• preprocess_data

field firstName: str = ''

Validated by:

• preprocess_data

field id: str = ''

Validated by:

• preprocess_data

field lastLogin: int [Required]

Validated by:

• preprocess_data

field lastName: str = ''

Validated by:

• preprocess_data

field practices: dict [Required]

Validated by:

• preprocess_data

field programs: dict [Required]

Validated by:

• preprocess_data

field system: System [Required]

Validated by:

• preprocess_data

field timeFormat: str = ''

Validated by:

• preprocess_data

field uiLanguage: str = ''

Validated by:

• preprocess_data

field uom: str = ''

Validated by:

• preprocess_data