projectal

A python client for the Projectal API.

Getting started

import projectal
import os

# Supply your Projectal server URL and account credentials
projectal.api_base = https://yourcompany.projectal.com
projectal.api_username = os.environ.get('PROJECTAL_USERNAME')
projectal.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.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 to projectal.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 the updated list follow the same old vs new 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 for links=[] 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 projectal.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 on Entity 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 (now juniorLevel, 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 to Company.get_primary_company()

  • Department.tree(): now consumes a holder Entity object instead of a uuId.

  • Department.tree(): added generic_staff parameter, new in Projectal 3.0.

  • Don't break on trailing slash in Projectal URL

  • When creating tasks, populate the projectRef and parent 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: projectal.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()
This will be resolved in a future release.

  • When creating Notes, the created and modified 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 an old=True flag. When this flag is true, the set of changes will now return both the original and the new values. E.g.
md5-e9d26e0e9480ea06e371e40114c1aa9c

  • 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 to response_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(), and projectal.timestamp_from_datetime().

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