projectal
A python client for the Projectal API.
Getting started
import projectal
import os
# Supply your Projectal server URL and account credentials
api_base = https://yourcompany.projectal.com
api_username = os.environ.get('PROJECTAL_USERNAME')
api_password = os.environ.get('PROJECTAL_PASSWORD')
# Test communication with server
status = projectal.status()
# Test account credentials
projectal.login()
details = projectal.auth_details()
Changelog
4.2.2
projectal.User.current_user_permissions()
fixed incorrect query.projectal.Webhook.list()
default limit increased to 1000.
4.2.1
Added classes allowing for the management of dynamic enums. The user must have the "List Management" permission to update enums.
New classes:
projectal.CompanyTypes
projectal.SkillLevels
projectal.StaffTypes
projectal.PriorityLevels
projectal.ComplexityLevels
projectal.CurrencyList
The current enum can be retrieved with get(), and updated with set(). For example, to return the current SkillLevels enum:
projectal.SkillLevels.get()
For each enum the entire list of key value pairs must be provided when calling set(), any existing values that are omitted from the dictionary will be removed, and any additional values will be added.
To update the SkillLevels enum with a new value:
new_value_added = { "Senior": 10, "Mid": 20, "Junior": 30, # new SkillLevel value "Beginner" "Beginner": 40, } projectal.SkillLevels.set(new_value_added)
To change the name of a value, set a new key name for the original value:
updated_value_name = { # changing "Senior" SkillLevel to "Expert" "Expert": 10, "Mid": 20, "Junior": 30, } projectal.SkillLevels.set(updated_value_name)
To remove an existing value, call set on a dictionary with that value removed:
value_removed = { "Senior": 10, "Mid": 20, # "Junior" SkillLevel removed } projectal.SkillLevels.set(new_value_added)
Updating the CurrencyList works differently to the other enums, since the names of values must match the alphabetic currency code and the value must match the numeric currency code. This will cause an exception if you try to change the name for any values.
Adding a new currency:
new_currency_added = { "AED": 784 ... # rest of the existing currencies ... # new currency to add with the alphabetic and numeric code "ZWL": 932, } projectal.CurrencyList.set(new_currency_added)
Removing an existing currency requires you to provide the numeric code for the currency as a negative value.
currency_removed = { # this currency will be removed "AED": -784 ... # rest of the existing currencies ... } projectal.CurrencyList.set(currency_removed)
4.2.0
Version 4.2.0 accompanies the release of Projectal 4.1.0
Minimum Projectal version is now 4.1.0.
Changed order of applying link types when an entity is initialized, prevents a type error with reverse linking in certain situations.
projectal.Task.reset_duration()
now supports adjustments with multi day calendar exceptions.projectal.Task.reset_duration()
location working days override base exceptions.projectal.TaskTemplate.list()
fixed incorrect query when using inherited method.
4.1.0
DateLimit.Max enum value changed from "9999-12-31" to "3000-01-01". This reflects changes to the Projectal backend that defines this as the maximum allowable date value. The front end typically considers this value as equivalent with having no end date.
Updated requirements.txt version for requests package
Minimum Projectal version is now 4.0.40
4.0.3
- When a dict object is passed to the update class method, it will be converted to the corresponding Entity type. Allows for proper handling of keys that require being treated as links.
4.0.2
Booking entity is now fetched with project field and either staff or resource field.
Added missing link methods for 'Booking' entity (Note, File)
Added missing link methods for 'Activity' entity (Booking, Note, File, Rebate)
Reduced maximum number of link methods to 100 for a single batch request to prevent timeouts under heavy load.
4.0.1
- Minimum Projectal version is now 4.0.0.
4.0.0
Version 4.0.0 accompanies the release of Projectal 4.0.
Added the
Activity
entity, new in Projectal 4.0.Added the
Booking
entity, new in Projectal 4.0.
3.1.1
- Link requests generated by 'projectal.Entity.create()' and 'projectal.Entity.update()' are now executed in batches. This is enabled by default with the 'batch_linking=True' parameter and can be disabled to execute each link request individually. It is recommended to leave this parameter enabled as this can greatly reduce the number of network requests.
3.1.0
Minimum Projectal version is now 3.1.5.
Added
projectal.Webhook.list_events()
. See API doc for details on how to use.Added
deleted_at
parameter toprojectal.Entity.get()
. This value should be a UTC timestamp from a webhook delete event.Added
projectal.ldap_sync()
to initiate a user sync with the LDAP/AD service configured in the Projectal server settings.Enhanced output of
projectal.Entity.changes()
function when reporting link changes. It no longer dumps the entire before-and-after list with the full content of each linked entity. Now reports three lists:added
,updated
,removed
. Entities within theupdated
list follow the sameold
vsnew
dictionary model for the data attributes within them. E.g:resourceList: [ 'added': [], 'updated': [ {'uuId': '14eb4c31-0f92-49d1-8b4d-507ab939003e', 'resourceLink': {'utilization': {'old': 0.1, 'new': 0.9}}}, ], 'removed': [] ]
This should result in slimmer logs that are much easier to understand as the changes are clearly indicated.
3.0.2
- Added
projectal.Entity.get_link_definitions()
. Exposes entity link definition dictionary. Consumers can inspect which links an Entity knows about and their internal settings. Link definitions that appear here are the links valid forlinks=[]
parameters.
3.0.1
Fixed fetching project with links=['task'] not being available.
Improved Permission.list(). Now returns a dict with the permission name as key with Permission objects as the value (instead of list of uuIds).
Added a way to use the aliasing feature of the API (new in Projectal 3.0). Set
api_alias = 'uuid'
to the UUID of a User object and all requests made will be done as that user. Restore this value to None to resume normal operation. (Some rules and limitations apply. See API for more details.)Added complete support for the Tags entity (including linkers).
3.0
Version 3.0 accompanies the release of Projectal 3.0.
Breaking changes:
The
links
parameter onEntity
functions now consumes a list of entity names instead of a comma-separated string. For example:# Before: projectal.Staff.get('<uuid>', links='skill,location') # No longer valid # Now: projectal.Staff.get('<uuid>', links=['skill', 'location'])
The
projectal.enums.SkillLevel
enum has had all values renamed to match the new values used in Projectal (Junior, Mid, Senior). This includes the properties on Skill entities indicating work time for auto-scheduling (nowjuniorLevel
,midLevel
,seniorLevel
).
Other changes:
Working with entity links has changed in this release. The previous methods are still available and continue to work as before, but there is no need to interact with the
projectal.linkers
methods yourself anymore.You can now modify the list of links within an entity and save the entity directly. The library will automatically determine how the links have been modified and issue the correct linker methods on your behalf. E.g., you can now do:
staff = projectal.Staff.get('<uuid>', links=['skill']) staff['firstName'] = "New name" # Field update staff['skillList'] = [skill1, skill2, skill3] # Link update staff.save() # Both changes are saved task = projectal.Task.get('<uuid>', links=['stage']) task['stage'] = stage1 # Uses a single object instead of list task.save()
See
examples/linking.py
for a more complete demonstration of linking capabilities and limitations.Linkers (
projectal.linkers
) can now be given a list of Entities (of one type) to link/unlink/relink in bulk. E.g:staff.unlink_skill(skill1) # Before staff.unlink_skill([skill1, skill2, skill3]) # This works now too
Linkers now strip the payload to only the required fields instead of passing on the entire Entity object. This cuts down on network traffic significantly.
Linkers now also work in reverse. The Projectal server currently only supports linking entities in one direction (e.g., Company to Staff), which often means writing something like:
staff.link_location(location) company.link_staff(staff)
The change in direction is not very intuitive and would require you to constantly verify which direction is the one available to you in the documentation.
Reverse linkers hide this from you and figure out the direction of the relationship for you behind the scenes. So now this is possible, even though the API doesn't strictly support it:
staff.link_location(location) staff.link_company(company)
Caveat: the documentation for Staff will not list Company links. You will still have to look up the Company documentation for the link description.
Requesting entity links with the
links=
parameter will now always ensure the link field (e.g.,taskList
) exists in the result, even if there are no links. The server may not always return a value, but we can use a default value ([] for lists, None for dicts).Added a
Permission
entity to correctly type Permissions in responses.Added a
Tag
entity, new in Projectal 3.0.Added
links
parameter toCompany.get_primary_company()
Department.tree()
: now consumes aholder
Entity object instead of a uuId.Department.tree()
: addedgeneric_staff
parameter, new in Projectal 3.0.Don't break on trailing slash in Projectal URL
When creating tasks, populate the
projectRef
andparent
fields in the returned Task object.Added convenience functions for matching on fields where you only want one result (e.g match_one()) which return the first match found.
Update the entity
history()
method for Projectal 3.0. Some new parameters allow you to restrict the history to a particular range or to get only the changes for a webhook timestamp.Entity objects can call
.history()
on themselves.The library now keeps a reference to the User account that is currently logged in and using the API:
api_auth_details
.
Known issues:
- You cannot save changes to Notes or Calendars via their holding entity. You
must save the changes on the Note or Calendar directly. To illustrate:
staff = projectal.Staff.get(<uuid>, links=['calendar']) calendar = staff['calendarList'][0] calendar['name'] = 'Calendar 2' # Cannot do this - will not pick up the changes staff.save() # You must do this for now calendar.save()
When creating Notes, the
created
andmodified
values may differ by 1ms in the object you have a reference to compared to what is actually stored in the database.Duration calculation is not precise yet (mentioned in 2.1.0)
2.1.0
**Breaking changes**: - Getting location calendar is now done on an instance instead of class. So `projectal.Location.calendar(uuid)` is now simply `location.calendar()` - The `CompanyType.Master` enum has been replaced with `CompanyType.Primary`. This was a leftover reference to the Master Company which was renamed in Projectal several versions ago. **Other changes**: - Date conversion functions return None when given None or empty string - Added `Task.reset_duration()` as a basic duration calculator for tasks. This is a work-in-progress and will be gradually improved. The duration calculator takes into consideration the location to remove non-work days from the estimate of working duration. It currently does not work for the time component or `isWorking=True` exceptions. - Change detection in `Entity.changes()` now excludes cases where the server has no value and the new value is None. Saving this change has no effect and would always detect a change until a non-None value is set, which is noisy and generates more network activity.2.0.3
- Better support for calendars.
- Distinguish between calendar containers ("Calendar") and the calendar items within them ("CalendarItem").
- Allow CalendarItems to be saved directly. E.G item.save()
- Fix 'holder' parameter in contact/staff/location/task_template not permitting object type. Now consumes uuId or object to match rest of the library.
Entity.changes()
has been extended with anold=True
flag. When this flag is true, the set of changes will now return both the original and the new values. E.g.
- Fixed entity link cache causing errors when deleting a link from an entity which has not been fetched with links (deleting from empty list).
2.0.2
- Fixed updating Webhook entities
2.0.1
- Fixed application ID not being used correctly.
2.0.0
- Version 2.0 accompanies the release of Projectal 2.0. There are no major changes since the previous release.
- Expose
Entity.changes()
function. It returns a list of fields on an entity that have changed since fetching it. These are the changes that will be sent over to the server when an update request is made. - Added missing 'packaging' dependency to requirements.
1.2.0
**Breaking changes**:- Renamed
request_timestamp
toresponse_timestamp
to better reflect its purpose. Automatic timestamp conversion into dates (introduced in
1.1.0
) has been reverted. All date fields returned from the server remain as UTC timestamps.The reason is that date fields on tasks contain a time component and converting them into date strings was erasing the time, resulting in a value that does not match the database.
Note: the server supports setting date fields using a date string like
2022-04-05
. You may use this if you prefer but the server will always return a timestamp.Note: we provide utility functions for easily converting dates from/to timestamps expected by the Projectal server. See:
projectal.date_from_timestamp()
,projectal.timestamp_from_date()
, andprojectal.timestamp_from_datetime()
.
Entity link methods now automatically update the entity's cached list of links. E.g: a task fetched with staff links will have
task['staffList'] = [Staff1,Staff2]
. Before, doing atask.link_staff(staff)
did not modify the list to reflect the addition. Now, it will turn into[Staff1,Staff2,Staff3]
. The same applies for update and delete.This allows you to modify links and continue working with that object without having to fetch it again to obtain the most recent link data. Be aware that if you acquire the object without requesting the link data as well (e.g:
projectal.Task.get(id, links='STAFF')
), these lists will not accurately reflect what's in the database, only the changes made while the object is held.Support new
applicationId
property on login. Set with:api_application_id
. The application ID is sent back to you in webhooks so you know which application was the source of the event (and you can choose to filter them accordingly).Added
Entity.set_readonly()
to allow setting values on entities that will not be sent over to the server when updating/saving the entity.The main use case for this is to populate cached entities which you have just created with values you already know about. This is mainly a workaround for the limitation of the server not sending the full object back after creating it, resulting in the client needing to fetch the object in full again if it needs some of the fields set by the server after creation.
Additionally, some read-only fields will generate an error on the server if included in the update request. This method lets you set these values on newly created objects without triggering this error.
A common example is setting the
projectRef
of a task you just created.
1.1.1
- Add support for 'profiles' API. Profiles are a type of key-value storage that target any entity. Not currently documented.
- Fix handling error message parsing in ProjectalException for batch create operation
- Add
Task.update_order()
to set task order - Return empty list when GETing empty list instead of failing (no request to server)
- Expose the timestamp returned by requests that modify the database. Use
projectal.request_timestamp
to get the value of the most recent request (None if no timestamp in response)
1.1.0
- Minimum Projectal version is now 1.9.4.
Breaking changes:
- Entity
list()
now returns a list of UUIDs instead of full objects. You may provide anexpand
parameter to restore the previous behavior:Entity.list(expand=True)
. This change is made for performance reasons where you may have thousands of tasks and getting them all may time out. For those cases, we suggest writing a query to filter down to only the tasks and fields you need. Company.get_master_company()
has been renamed toCompany.get_primary_company()
to match the server.- The following date fields are converted into date strings upon fetch:
startTime
,closeTime
,scheduleStart
,scheduleFinish
. These fields are added or updated using date strings (like2022-03-02
), but the server returns timestamps (e.g: 1646006400000) upon fetch, which is confusing. This change ensures they are always date strings for consistency.
Other changes:
- When updating an entity, only the fields that have changed are sent to the server. When updating a list of entities, unmodified entities are not sent to the server at all. This dramatically reduces the payload size and should speed things up.
- When fetching entities, entity links are now typed as well. E.g.
project['rebateList']
contains a list ofRebate
instead ofdict
. - Added
date_from_timestamp()
andtimestamp_from_date()
functions to help with converting to/from dates and Projectal timestamps. - Entity history now uses
desc
by default (index 0 is newest) - Added
Project.tasks()
to list all task UUIDs within a project.
1.0.3
- Fix another case of automatic JWT refresh not working
1.0.2
- Entity instances can
save()
ordelete()
on themselves - Fix broken
dict
methods (get()
andupdate()
) when called from Entity instances - Fix automatic JWT refresh only working in some cases
1.0.1
- Added
list()
function for all entities - Added search functions for all entities (match-, search, query)
- Added
Company.get_master_company()
- Fixed adding template tasks
1""" 2A python client for the [Projectal API](https://projectal.com/docs/latest). 3 4## Getting started 5 6``` 7import projectal 8import os 9 10# Supply your Projectal server URL and account credentials 11projectal.api_base = https://yourcompany.projectal.com 12projectal.api_username = os.environ.get('PROJECTAL_USERNAME') 13projectal.api_password = os.environ.get('PROJECTAL_PASSWORD') 14 15# Test communication with server 16status = projectal.status() 17 18# Test account credentials 19projectal.login() 20details = projectal.auth_details() 21``` 22 23---- 24 25## Changelog 26 27### 4.2.2 28- `projectal.User.current_user_permissions()` fixed incorrect query. 29- `projectal.Webhook.list()` default limit increased to 1000. 30 31### 4.2.1 32- Added classes allowing for the management of dynamic enums. The user must have the "List Management" 33 permission to update enums. 34 35 New classes: 36 - `projectal.CompanyTypes` 37 - `projectal.SkillLevels` 38 - `projectal.StaffTypes` 39 - `projectal.PriorityLevels` 40 - `projectal.ComplexityLevels` 41 - `projectal.CurrencyList` 42 43 The current enum can be retrieved with get(), and updated with set(). 44 For example, to return the current SkillLevels enum: 45 46 ``` 47 projectal.SkillLevels.get() 48 ``` 49 50 For each enum the entire list of key value pairs must be provided when calling set(), 51 any existing values that are omitted from the dictionary will be removed, 52 and any additional values will be added. 53 54 To update the SkillLevels enum with a new value: 55 56 ``` 57 new_value_added = { 58 "Senior": 10, 59 "Mid": 20, 60 "Junior": 30, 61 # new SkillLevel value "Beginner" 62 "Beginner": 40, 63 } 64 projectal.SkillLevels.set(new_value_added) 65 ``` 66 67 To change the name of a value, set a new key name for the original value: 68 69 ``` 70 updated_value_name = { 71 # changing "Senior" SkillLevel to "Expert" 72 "Expert": 10, 73 "Mid": 20, 74 "Junior": 30, 75 } 76 projectal.SkillLevels.set(updated_value_name) 77 ``` 78 79 To remove an existing value, call set on a dictionary with that value removed: 80 81 ``` 82 value_removed = { 83 "Senior": 10, 84 "Mid": 20, 85 # "Junior" SkillLevel removed 86 } 87 projectal.SkillLevels.set(new_value_added) 88 ``` 89 90 Updating the CurrencyList works differently to the other enums, since the 91 names of values must match the alphabetic currency code and the value must 92 match the numeric currency code. 93 This will cause an exception if you try to change the name for any values. 94 95 Adding a new currency: 96 97 ``` 98 new_currency_added = { 99 "AED": 784 100 ... 101 # rest of the existing currencies 102 ... 103 # new currency to add with the alphabetic and numeric code 104 "ZWL": 932, 105 } 106 projectal.CurrencyList.set(new_currency_added) 107 ``` 108 109 Removing an existing currency requires you to provide the numeric code for 110 the currency as a negative value. 111 112 ``` 113 currency_removed = { 114 # this currency will be removed 115 "AED": -784 116 ... 117 # rest of the existing currencies 118 ... 119 } 120 projectal.CurrencyList.set(currency_removed) 121 ``` 122 123### 4.2.0 124Version 4.2.0 accompanies the release of Projectal 4.1.0 125 126- Minimum Projectal version is now 4.1.0. 127 128- Changed order of applying link types when an entity is initialized, 129prevents a type error with reverse linking in certain situations. 130 131- `projectal.Task.reset_duration()` now supports adjustments with multi day calendar exceptions. 132 133- `projectal.Task.reset_duration()` location working days override base exceptions. 134 135- `projectal.TaskTemplate.list()` fixed incorrect query when using inherited method. 136 137### 4.1.0 138- DateLimit.Max enum value changed from "9999-12-31" to "3000-01-01". This reflects changes to the Projectal 139backend that defines this as the maximum allowable date value. The front end typically considers this value as 140equivalent with having no end date. 141 142- Updated requirements.txt version for requests package 143 144- Minimum Projectal version is now 4.0.40 145 146### 4.0.3 147- When a dict object is passed to the update class method, it will be converted to the corresponding Entity type. 148 Allows for proper handling of keys that require being treated as links. 149 150### 4.0.2 151- Booking entity is now fetched with project field and either staff or resource field. 152 153- Added missing link methods for 'Booking' entity (Note, File) 154 155- Added missing link methods for 'Activity' entity (Booking, Note, File, Rebate) 156 157- Reduced maximum number of link methods to 100 for a single batch request to prevent timeouts 158under heavy load. 159 160### 4.0.1 161- Minimum Projectal version is now 4.0.0. 162 163### 4.0.0 164 165Version 4.0.0 accompanies the release of Projectal 4.0. 166 167- Added the `Activity` entity, new in Projectal 4.0. 168 169- Added the `Booking` entity, new in Projectal 4.0. 170 171### 3.1.1 172- Link requests generated by 'projectal.Entity.create()' and 'projectal.Entity.update()' are now 173 executed in batches. This is enabled by default with the 'batch_linking=True' parameter and can 174 be disabled to execute each link request individually. It is recommended to leave this parameter 175 enabled as this can greatly reduce the number of network requests. 176 177### 3.1.0 178- Minimum Projectal version is now 3.1.5. 179 180- Added `projectal.Webhook.list_events()`. See API doc for details on how to use. 181 182- Added `deleted_at` parameter to `projectal.Entity.get()`. This value should be a UTC timestamp 183 from a webhook delete event. 184 185- Added `projectal.ldap_sync()` to initiate a user sync with the LDAP/AD service configured in 186 the Projectal server settings. 187 188- Enhanced output of `projectal.Entity.changes()` function when reporting link changes. 189 It no longer dumps the entire before-and-after list with the full content of each linked entity. 190 Now reports three lists: `added`, `updated`, `removed`. Entities within the `updated` list 191 follow the same `old` vs `new` dictionary model for the data attributes within them. E.g: 192 193 ``` 194 resourceList: [ 195 'added': [], 196 'updated': [ 197 {'uuId': '14eb4c31-0f92-49d1-8b4d-507ab939003e', 'resourceLink': {'utilization': {'old': 0.1, 'new': 0.9}}}, 198 ], 199 'removed': [] 200 ] 201 ``` 202 This should result in slimmer logs that are much easier to understand as the changes are 203 clearly indicated. 204 205### 3.0.2 206- Added `projectal.Entity.get_link_definitions()`. Exposes entity link definition dictionary. 207 Consumers can inspect which links an Entity knows about and their internal settings. 208 Link definitions that appear here are the links valid for `links=[]` parameters. 209 210### 3.0.1 211- Fixed fetching project with links=['task'] not being available. 212 213- Improved Permission.list(). Now returns a dict with the permission name as 214 key with Permission objects as the value (instead of list of uuIds). 215 216- Added a way to use the aliasing feature of the API (new in Projectal 3.0). 217Set `projectal.api_alias = 'uuid'` to the UUID of a User object and all 218requests made will be done as that user. Restore this value to None to resume 219normal operation. (Some rules and limitations apply. See API for more details.) 220 221- Added complete support for the Tags entity (including linkers). 222 223### 3.0 224 225Version 3.0 accompanies the release of Projectal 3.0. 226 227**Breaking changes**: 228 229- The `links` parameter on `Entity` functions now consumes a list of entity 230 names instead of a comma-separated string. For example: 231 232 ``` 233 # Before: 234 projectal.Staff.get('<uuid>', links='skill,location') # No longer valid 235 # Now: 236 projectal.Staff.get('<uuid>', links=['skill', 'location']) 237 ``` 238 239- The `projectal.enums.SkillLevel` enum has had all values renamed to match the new values 240 used in Projectal (Junior, Mid, Senior). This includes the properties on 241 Skill entities indicating work time for auto-scheduling (now `juniorLevel`, 242 `midLevel`, `seniorLevel`). 243 244**Other changes**: 245 246- Working with entity links has changed in this release. The previous methods 247 are still available and continue to work as before, but there is no need 248 to interact with the `projectal.linkers` methods yourself anymore. 249 250 You can now modify the list of links within an entity and save the entity 251 directly. The library will automatically determine how the links have been 252 modified and issue the correct linker methods on your behalf. E.g., 253 you can now do: 254 255 ``` 256 staff = projectal.Staff.get('<uuid>', links=['skill']) 257 staff['firstName'] = "New name" # Field update 258 staff['skillList'] = [skill1, skill2, skill3] # Link update 259 staff.save() # Both changes are saved 260 261 task = projectal.Task.get('<uuid>', links=['stage']) 262 task['stage'] = stage1 # Uses a single object instead of list 263 task.save() 264 ``` 265 266 See `examples/linking.py` for a more complete demonstration of linking 267 capabilities and limitations. 268 269- Linkers (`projectal.linkers`) can now be given a list of Entities (of one 270 type) to link/unlink/relink in bulk. E.g: 271 ``` 272 staff.unlink_skill(skill1) # Before 273 staff.unlink_skill([skill1, skill2, skill3]) # This works now too 274 ``` 275 276- Linkers now strip the payload to only the required fields instead of passing 277 on the entire Entity object. This cuts down on network traffic significantly. 278 279- Linkers now also work in reverse. The Projectal server currently only supports 280 linking entities in one direction (e.g., Company to Staff), which often means 281 writing something like: 282 ``` 283 staff.link_location(location) 284 company.link_staff(staff) 285 ``` 286 The change in direction is not very intuitive and would require you to constantly 287 verify which direction is the one available to you in the documentation. 288 289 Reverse linkers hide this from you and figure out the direction of the relationship 290 for you behind the scenes. So now this is possible, even though the API doesn't 291 strictly support it: 292 ``` 293 staff.link_location(location) 294 staff.link_company(company) 295 ``` 296 Caveat: the documentation for Staff will not list Company links. You will still 297 have to look up the Company documentation for the link description. 298 299- Requesting entity links with the `links=` parameter will now always ensure the 300 link field (e.g., `taskList`) exists in the result, even if there are no links. 301 The server may not always return a value, but we can use a default value ([] for 302 lists, None for dicts). 303 304- Added a `Permission` entity to correctly type Permissions in responses. 305 306- Added a `Tag` entity, new in Projectal 3.0. 307 308- Added `links` parameter to `Company.get_primary_company()` 309 310- `Department.tree()`: now consumes a `holder` Entity object instead 311 of a uuId. 312 313- `Department.tree()`: added `generic_staff` parameter, new in 314 Projectal 3.0. 315 316- Don't break on trailing slash in Projectal URL 317 318- When creating tasks, populate the `projectRef` and `parent` fields in the 319 returned Task object. 320 321- Added convenience functions for matching on fields where you only want 322 one result (e.g match_one()) which return the first match found. 323 324- Update the entity `history()` method for Projectal 3.0. Some new parameters 325 allow you to restrict the history to a particular range or to get only the 326 changes for a webhook timestamp. 327 328- Entity objects can call `.history()` on themselves. 329 330- The library now keeps a reference to the User account that is currently logged 331 in and using the API: `projectal.api_auth_details`. 332 333**Known issues**: 334- You cannot save changes to Notes or Calendars via their holding entity. You 335 must save the changes on the Note or Calendar directly. To illustrate: 336 ``` 337 staff = projectal.Staff.get(<uuid>, links=['calendar']) 338 calendar = staff['calendarList'][0] 339 calendar['name'] = 'Calendar 2' 340 341 # Cannot do this - will not pick up the changes 342 staff.save() 343 344 # You must do this for now 345 calendar.save() 346 ``` 347 This will be resolved in a future release. 348 349- When creating Notes, the `created` and `modified` values may differ by 350 1ms in the object you have a reference to compared to what is actually 351 stored in the database. 352 353- Duration calculation is not precise yet (mentioned in 2.1.0) 354 355### 2.1.0 356**Breaking changes**: 357- Getting location calendar is now done on an instance instead of class. So 358 `projectal.Location.calendar(uuid)` is now simply `location.calendar()` 359- The `CompanyType.Master` enum has been replaced with `CompanyType.Primary`. 360 This was a leftover reference to the Master Company which was renamed in 361 Projectal several versions ago. 362 363**Other changes**: 364- Date conversion functions return None when given None or empty string 365- Added `Task.reset_duration()` as a basic duration calculator for tasks. 366 This is a work-in-progress and will be gradually improved. The duration 367 calculator takes into consideration the location to remove non-work 368 days from the estimate of working duration. It currently does not work 369 for the time component or `isWorking=True` exceptions. 370- Change detection in `Entity.changes()` now excludes cases where the 371 server has no value and the new value is None. Saving this change has 372 no effect and would always detect a change until a non-None value is 373 set, which is noisy and generates more network activity. 374 375### 2.0.3 376- Better support for calendars. 377 - Distinguish between calendar containers ("Calendar") and the 378 calendar items within them ("CalendarItem"). 379 - Allow CalendarItems to be saved directly. E.G item.save() 380- Fix 'holder' parameter in contact/staff/location/task_template not 381 permitting object type. Now consumes uuId or object to match rest of 382 the library. 383- `Entity.changes()` has been extended with an `old=True` flag. When 384 this flag is true, the set of changes will now return both the original 385 and the new values. E.g. 386``` 387task.changes() 388# {'name': 'current'} 389task.changes(old=True) 390# {'name': {'old': 'original', 'new': 'current'}} 391``` 392- Fixed entity link cache causing errors when deleting a link from an entity 393 which has not been fetched with links (deleting from empty list). 394 395### 2.0.2 396- Fixed updating Webhook entities 397 398### 2.0.1 399- Fixed application ID not being used correctly. 400 401### 2.0.0 402- Version 2.0 accompanies the release of Projectal 2.0. There are no major changes 403 since the previous release. 404- Expose `Entity.changes()` function. It returns a list of fields on an entity that 405 have changed since fetching it. These are the changes that will be sent over to the 406 server when an update request is made. 407- Added missing 'packaging' dependency to requirements. 408 409### 1.2.0 410 411**Breaking changes**: 412 413- Renamed `request_timestamp` to `response_timestamp` to better reflect its purpose. 414- Automatic timestamp conversion into dates (introduced in `1.1.0`) has been reverted. 415 All date fields returned from the server remain as UTC timestamps. 416 417 The reason is that date fields on tasks contain a time component and converting them 418 into date strings was erasing the time, resulting in a value that does not match 419 the database. 420 421 Note: the server supports setting date fields using a date string like `2022-04-05`. 422 You may use this if you prefer but the server will always return a timestamp. 423 424 Note: we provide utility functions for easily converting dates from/to 425 timestamps expected by the Projectal server. See: 426 `projectal.date_from_timestamp()`,`projectal.timestamp_from_date()`, and 427 `projectal.timestamp_from_datetime()`. 428 429**Other changes**: 430- Implement request chunking - for methods that consume a list of entities, we now 431 automatically batch them up into multiple requests to prevent timeouts on really 432 large request. Values are configurable through 433 `projectal.chunk_size_read` and `projectal.chunk_size_write`. 434 Default values: Read: 1000 items. Write: 200 items. 435- Added profile get/set functions on entities for easier use. Now you only need to supply 436 the key and the data. E.g: 437 438``` 439key = 'hr_connector' 440data = {'staff_source': 'company_z'} 441task.profile_set(key, data) 442``` 443 444- Entity link methods now automatically update the entity's cached list of links. E.g: 445 a task fetched with staff links will have `task['staffList'] = [Staff1,Staff2]`. 446 Before, doing a `task.link_staff(staff)` did not modify the list to reflect the 447 addition. Now, it will turn into `[Staff1,Staff2,Staff3]`. The same applies for update 448 and delete. 449 450 This allows you to modify links and continue working with that object without having 451 to fetch it again to obtain the most recent link data. Be aware that if you acquire 452 the object without requesting the link data as well 453 (e.g: `projectal.Task.get(id, links='STAFF')`), 454 these lists will not accurately reflect what's in the database, only the changes made 455 while the object is held. 456 457- Support new `applicationId` property on login. Set with: `projectal.api_application_id`. 458 The application ID is sent back to you in webhooks so you know which application was 459 the source of the event (and you can choose to filter them accordingly). 460- Added `Entity.set_readonly()` to allow setting values on entities that will not 461 be sent over to the server when updating/saving the entity. 462 463 The main use case for this is to populate cached entities which you have just created 464 with values you already know about. This is mainly a workaround for the limitation of 465 the server not sending the full object back after creating it, resulting in the client 466 needing to fetch the object in full again if it needs some of the fields set by the 467 server after creation. 468 469 Additionally, some read-only fields will generate an error on the server if 470 included in the update request. This method lets you set these values on newly 471 created objects without triggering this error. 472 473 A common example is setting the `projectRef` of a task you just created. 474 475 476### 1.1.1 477- Add support for 'profiles' API. Profiles are a type of key-value storage that target 478 any entity. Not currently documented. 479- Fix handling error message parsing in ProjectalException for batch create operation 480- Add `Task.update_order()` to set task order 481- Return empty list when GETing empty list instead of failing (no request to server) 482- Expose the timestamp returned by requests that modify the database. Use 483 `projectal.request_timestamp` to get the value of the most recent request (None 484 if no timestamp in response) 485 486### 1.1.0 487- Minimum Projectal version is now 1.9.4. 488 489**Breaking changes**: 490- Entity `list()` now returns a list of UUIDs instead of full objects. You may provide 491 an `expand` parameter to restore the previous behavior: `Entity.list(expand=True)`. 492 This change is made for performance reasons where you may have thousands of tasks 493 and getting them all may time out. For those cases, we suggest writing a query to filter 494 down to only the tasks and fields you need. 495- `Company.get_master_company()` has been renamed to `Company.get_primary_company()` 496 to match the server. 497- The following date fields are converted into date strings upon fetch: 498 `startTime`, `closeTime`, `scheduleStart`, `scheduleFinish`. 499 These fields are added or updated using date strings (like `2022-03-02`), but the 500 server returns timestamps (e.g: 1646006400000) upon fetch, which is confusing. This 501 change ensures they are always date strings for consistency. 502 503**Other changes**: 504- When updating an entity, only the fields that have changed are sent to the server. When 505 updating a list of entities, unmodified entities are not sent to the server at all. This 506 dramatically reduces the payload size and should speed things up. 507- When fetching entities, entity links are now typed as well. E.g. `project['rebateList']` 508 contains a list of `Rebate` instead of `dict`. 509- Added `date_from_timestamp()` and `timestamp_from_date()` functions to help with 510 converting to/from dates and Projectal timestamps. 511- Entity history now uses `desc` by default (index 0 is newest) 512- Added `Project.tasks()` to list all task UUIDs within a project. 513 514### 1.0.3 515- Fix another case of automatic JWT refresh not working 516 517### 1.0.2 518- Entity instances can `save()` or `delete()` on themselves 519- Fix broken `dict` methods (`get()` and `update()`) when called from Entity instances 520- Fix automatic JWT refresh only working in some cases 521 522### 1.0.1 523- Added `list()` function for all entities 524- Added search functions for all entities (match-, search, query) 525- Added `Company.get_master_company()` 526- Fixed adding template tasks 527 528""" 529import logging 530import os 531 532from projectal.entities import * 533from projectal.dynamic_enums import * 534from .api import * 535from . import profile 536 537api_base = os.getenv("PROJECTAL_URL") 538api_username = os.getenv("PROJECTAL_USERNAME") 539api_password = os.getenv("PROJECTAL_PASSWORD") 540api_application_id = None 541api_auth_details = None 542api_alias = None 543cookies = None 544chunk_size_read = 1000 545chunk_size_write = 200 546 547# Records the timestamp generated by the last request (database 548# event time). These are reported on add or updates; if there is 549# no timestamp in the response, this is set to None. 550response_timestamp = None 551 552 553# The minimum version number of the Projectal instance that this 554# API client targets. Lower versions are not supported and will 555# raise an exception. 556MIN_PROJECTAL_VERSION = "4.0.40" 557 558__verify = True 559 560logging.getLogger("projectal-api-client").addHandler(logging.NullHandler())