Models
Abstract Classes¶
toggl_api.models.TogglClass
dataclass
¶
Bases: ABC
Base class for all Toggl dataclasses.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl model.
TYPE:
|
name
|
Name or description of the Toggl project.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl project was last modified. |
METHOD | DESCRIPTION |
---|---|
from_kwargs |
Convert an arbitrary amount of kwargs to a model. |
Source code in src/toggl_api/models/_models.py
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 |
|
from_kwargs
abstractmethod
classmethod
¶
from_kwargs(**kwargs: Any) -> Self
Convert an arbitrary amount of kwargs to a model.
RETURNS | DESCRIPTION |
---|---|
Self
|
A newly created |
Source code in src/toggl_api/models/_models.py
53 54 55 56 57 58 59 60 61 62 63 64 65 |
|
toggl_api.models.WorkspaceChild
dataclass
¶
Bases: TogglClass
Base class for all Toggl workspace objects.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl object.
TYPE:
|
name
|
Name of the object.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl object was last modified. |
workspace
|
The workspace id the Toggl object belongs to.
TYPE:
|
METHOD | DESCRIPTION |
---|---|
from_kwargs |
Convert an arbitrary amount of kwargs to workspace object. |
ATTRIBUTE | DESCRIPTION |
---|---|
workspace |
The id of the workspace that the model belongs to.
TYPE:
|
Source code in src/toggl_api/models/_models.py
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 |
|
workspace
class-attribute
instance-attribute
¶
The id of the workspace that the model belongs to.
from_kwargs
classmethod
¶
from_kwargs(**kwargs: Any) -> Self
Convert an arbitrary amount of kwargs to workspace object.
PARAMETER | DESCRIPTION |
---|---|
**kwargs
|
Arbitary values values to convert.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Self
|
An initialized |
Source code in src/toggl_api/models/_models.py
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
Main Models¶
toggl_api.TogglOrganization
dataclass
¶
Bases: TogglClass
Data structure for Toggl organizations.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl organization.
TYPE:
|
name
|
Name of the Toggl organization. Max 140 characters and min 1 character.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl organization was last modified. |
METHOD | DESCRIPTION |
---|---|
validate_name |
Check if a organization name is valid for the API. |
from_kwargs |
Convert an arbitrary amount of kwargs to an organization. |
Source code in src/toggl_api/models/_models.py
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 |
|
validate_name
staticmethod
¶
Check if a organization name is valid for the API.
PARAMETER | DESCRIPTION |
---|---|
name
|
The name to check as a string.
TYPE:
|
max_len
|
Maximum length to allow.
TYPE:
|
RAISES | DESCRIPTION |
---|---|
NamingError
|
If the name provided is not valid. |
Source code in src/toggl_api/models/_models.py
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
|
from_kwargs
classmethod
¶
from_kwargs(**kwargs: Any) -> Self
Convert an arbitrary amount of kwargs to an organization.
RETURNS | DESCRIPTION |
---|---|
Self
|
A new created |
Source code in src/toggl_api/models/_models.py
90 91 92 93 94 95 96 97 |
|
toggl_api.TogglWorkspace
dataclass
¶
Bases: TogglClass
Data structure for Toggl workspaces.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl workspace.
TYPE:
|
name
|
Name of the workspace.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl workspace was last modified. |
organization
|
Organization id the workspace belongs to.
TYPE:
|
METHOD | DESCRIPTION |
---|---|
validate_name |
Check if a workspace name is valid for the API. |
from_kwargs |
Convert an arbitrary amount of kwargs to a workspace. |
Source code in src/toggl_api/models/_models.py
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 |
|
validate_name
staticmethod
¶
Check if a workspace name is valid for the API.
PARAMETER | DESCRIPTION |
---|---|
name
|
The name to check as a string.
TYPE:
|
max_len
|
Maximum length to allow.
TYPE:
|
RAISES | DESCRIPTION |
---|---|
NamingError
|
If the name provided is not valid. |
Source code in src/toggl_api/models/_models.py
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
from_kwargs
classmethod
¶
from_kwargs(**kwargs: Any) -> Self
Convert an arbitrary amount of kwargs to a workspace.
PARAMETER | DESCRIPTION |
---|---|
**kwargs
|
Arbitary values values to convert.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Self
|
An initialized |
Source code in src/toggl_api/models/_models.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
|
toggl_api.TogglClient
dataclass
¶
Bases: WorkspaceChild
Data structure for Toggl clients.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl client.
TYPE:
|
name
|
Name of the client.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl client was last modified. |
workspace
|
The workspace id the Toggl client belongs to.
TYPE:
|
METHOD | DESCRIPTION |
---|---|
from_kwargs |
Convert an arbitrary amount of kwargs to a client. |
Source code in src/toggl_api/models/_models.py
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 |
|
from_kwargs
classmethod
¶
from_kwargs(**kwargs: Any) -> TogglClient
Convert an arbitrary amount of kwargs to a client.
PARAMETER | DESCRIPTION |
---|---|
**kwargs
|
Arbitary values values to convert.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
TogglClient
|
An initialized |
Source code in src/toggl_api/models/_models.py
236 237 238 239 240 241 242 243 244 245 246 |
|
toggl_api.TogglProject
dataclass
¶
Bases: WorkspaceChild
Data structure for Toggl projects.
ATTRIBUTE | DESCRIPTION |
---|---|
Status |
An enumeration with all project statuses supported by the API.
|
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl project.
TYPE:
|
name
|
Name of the project.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl project was last modified. |
workspace
|
The workspace id the project belongs to.
TYPE:
|
color
|
Color of the project. Defaults to blue. Refer to this endpoint attribute for basic colors.
TYPE:
|
client
|
ID of the client the project belongs to. Defaults to None.
TYPE:
|
active
|
Whether the project is archived or not. Defaults to True.
TYPE:
|
start_date
|
When the project is supposed to start. Will default to the original date.
TYPE:
|
end_date
|
When the projects is supposed to end. None if there is no deadline. Optional.
TYPE:
|
CLASS | DESCRIPTION |
---|---|
Status |
|
METHOD | DESCRIPTION |
---|---|
get_status |
Derive the project status from instance attributes. |
from_kwargs |
Convert an arbitrary amount of kwargs to a project. |
Source code in src/toggl_api/models/_models.py
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 |
|
Status
¶
Bases: Enum
Source code in src/toggl_api/models/_models.py
271 272 273 274 275 276 |
|
get_status
¶
get_status() -> Status
Derive the project status from instance attributes.
RETURNS | DESCRIPTION |
---|---|
Status
|
A status enumeration based on the project attributes. |
Source code in src/toggl_api/models/_models.py
322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
|
from_kwargs
classmethod
¶
from_kwargs(**kwargs: Any) -> TogglProject
Convert an arbitrary amount of kwargs to a project.
PARAMETER | DESCRIPTION |
---|---|
**kwargs
|
Arbitary values values to convert.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
TogglProject
|
An initialized |
Source code in src/toggl_api/models/_models.py
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
|
toggl_api.TogglTracker
dataclass
¶
Bases: WorkspaceChild
Data structure for trackers.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl tracker.
TYPE:
|
name
|
Description of the tracker. Refers to tracker description inside the Toggl API.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl tracker was last modified. |
workspace
|
The workspace id the tracker belongs to.
TYPE:
|
start
|
Start time of the tracker. Defaults to time created if nothing is passed. |
duration
|
Duration of the tracker
TYPE:
|
stop
|
Stop time of the tracker. |
project
|
Id of the project the tracker is assigned to.
TYPE:
|
tags
|
List of tags. |
METHOD | DESCRIPTION |
---|---|
running |
Whether the tracker is running. |
Source code in src/toggl_api/models/_models.py
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 |
|
running
¶
running() -> bool
Is the tracker running.
RETURNS | DESCRIPTION |
---|---|
bool
|
True if the tracker is running. |
Source code in src/toggl_api/models/_models.py
390 391 392 393 394 395 396 |
|
from_kwargs
classmethod
¶
from_kwargs(**kwargs: Any) -> Self
Convert an arbitrary amount of kwargs to a tracker.
PARAMETER | DESCRIPTION |
---|---|
**kwargs
|
Arbitary values values to convert.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Self
|
An initialized |
Source code in src/toggl_api/models/_models.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
|
toggl_api.TogglTag
dataclass
¶
Bases: WorkspaceChild
Data structure for Toggl tags.
PARAMETER | DESCRIPTION |
---|---|
id
|
Toggl API / Database ID (Primary Key) of the Toggl tag.
TYPE:
|
name
|
Name of the tag.
TYPE:
|
timestamp
|
Local timestamp of when the Toggl tag was last modified. |
workspace
|
The workspace id the tag belongs to.
TYPE:
|
METHOD | DESCRIPTION |
---|---|
from_kwargs |
Convert an arbitrary amount of kwargs to a tag. |
Source code in src/toggl_api/models/_models.py
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
|
from_kwargs
classmethod
¶
Convert an arbitrary amount of kwargs to a tag.
PARAMETER | DESCRIPTION |
---|---|
**kwargs
|
Arbitary values values to convert.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
TogglTag
|
An initialized |
Source code in src/toggl_api/models/_models.py
476 477 478 479 480 481 482 483 484 485 486 |
|
toggl_api.models.as_dict_custom
¶
as_dict_custom(obj: TogglClass) -> dict[str, Any]
Convert a TogglClass` to a dictionary.
PARAMETER | DESCRIPTION |
---|---|
obj
|
A
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
dict[str, Any]
|
|
Source code in src/toggl_api/models/__init__.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
|