1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
|
"""Cookidoo API types."""
from dataclasses import dataclass, field
@dataclass
class CookidooLocalizationConfig:
"""A localization config class."""
country_code: str = "ch"
language: str = "de-CH"
url: str = "https://cookidoo.ch/foundation/de-CH"
@dataclass
class CookidooConfig:
"""Cookidoo config type.
Attributes
----------
localization
The localization for the api including country, language and url
email
The email to login
password
The password to login
"""
localization: CookidooLocalizationConfig = field(
default_factory=lambda: CookidooLocalizationConfig()
)
email: str = "your@email"
password: str = "1234password!"
@dataclass
class CookidooAuthResponse:
"""An auth response class."""
access_token: str
refresh_token: str
token_type: str
expires_in: int
sub: str
@dataclass
class CookidooUserInfo:
"""A user info class."""
username: str
description: str | None
picture: str | None
@dataclass
class CookidooSubscription:
"""A subscription class."""
active: bool
expires: str
start_date: str
status: str
subscription_level: str
subscription_source: str
type: str
extended_type: str
@dataclass
class CookidooIngredient:
"""Cookidoo ingredient type.
Attributes
----------
id
The id of the ingredient
name
The label of the ingredient
description
The description of the item, including the quantity or other helpful information
"""
id: str
name: str
description: str
@dataclass
class CookidooItem:
"""Cookidoo item type.
Attributes
----------
id
The id of the item
name
The label of the item
"""
id: str
name: str
is_owned: bool
@dataclass
class CookidooIngredientItem(CookidooItem):
"""Cookidoo ingredient item type.
Attributes
----------
description
The description of the item, including the quantity or other helpful information
"""
description: str
@dataclass
class CookidooAdditionalItem(CookidooItem):
"""Cookidoo additional item type."""
pass
@dataclass
class CookidooShoppingRecipe:
"""Cookidoo shopping recipe type.
Attributes
----------
id
The id of the recipe
name
The label of the recipe
ingredients
The ingredients of the recipe
"""
id: str
name: str
ingredients: list[CookidooIngredient]
@dataclass
class CookidooCategory:
"""Cookidoo category type.
Attributes
----------
id
The id of the category
name
The label of the category
notes
The additional information of the category
"""
id: str
name: str
notes: str
@dataclass
class CookidooRecipeCollection:
"""Cookidoo recipe collection type.
Attributes
----------
id
The id of the collection
name
The label of the collection
additional_information
The additional information of the collection
"""
id: str
name: str
total_recipes: int
@dataclass
class CookidooShoppingRecipeDetails(CookidooShoppingRecipe):
"""Cookidoo recipe details type.
Attributes
----------
difficulty
The difficulty of the recipe
notes
Hints and additional information about the recipe
categories
The categories of the recipe
collections
The collections of the recipe
utensils
The utensils needed for the recipe
serving_size
The service size of the recipe
active_time
The time needed preparing the recipe [in seconds]
total_time
The time needed until the recipe is ready [in seconds]
"""
difficulty: str
notes: list[str]
categories: list[CookidooCategory]
collections: list[CookidooRecipeCollection]
utensils: list[str]
serving_size: int
active_time: int
total_time: int
@dataclass
class CookidooChapterRecipe:
"""Cookidoo chapter recipe type.
Attributes
----------
id
The id of the recipe
name
The label of the recipe
total_time
The time for the recipe
"""
id: str
name: str
total_time: int
@dataclass
class CookidooChapter:
"""Cookidoo chapter type.
Attributes
----------
title
The title of the chapter
recipes
The recipes in the chapter
"""
name: str
recipes: list[CookidooChapterRecipe]
@dataclass
class CookidooCustomRecipe:
"""Cookidoo custom recipe type.
Attributes
----------
id
The id of the recipe
name
The label of the recipe
ingredients
The ingredients of the recipe
instructions
The instructions of the recipe
tools
The tools needed for the recipe
serving_size
The service size of the recipe
active_time
The time needed preparing the recipe [in seconds]
total_time
The time needed until the recipe is ready [in seconds]
"""
id: str
name: str
ingredients: list[str]
instructions: list[str]
tools: list[str]
serving_size: int
active_time: int
total_time: int
@dataclass
class CookidooCollection:
"""Cookidoo collection type.
Attributes
----------
id
The id of the collection
title
The title of the collection
description
The description of the collection
chapters
The recipes in the collection
"""
id: str
name: str
description: str | None
chapters: list[CookidooChapter]
@dataclass
class CookidooCalendarDayRecipe:
"""Cookidoo calendar day recipe type.
Attributes
----------
id
The id of the recipe
name
The label of the recipe
total_time
The time for the recipe
"""
id: str
name: str
total_time: int
@dataclass
class CookidooCalendarDay:
"""Cookidoo calendar day type.
Attributes
----------
id
The id of the calendar day
title
The title of the calendar day
recipes
The recipes in the calendar day
"""
id: str
title: str
recipes: list[CookidooCalendarDayRecipe]
|