Documentation

Scripting Changelog

Table of Contents

Version 1.10.0 (2024-10-07)

  • Added api.resources.credentials_required to get a list of all required credentials for a resource.

Version 1.9.0 (2024-09-13)

  • Added include_blocked to all reservation API functions and default it to False (previously defaulted True and was unchangable and considered a bug and unexpected behaviour).

Version 1.8.0 (2024-08-28)

  • Added purpose, 'note', 'lockPurpose', and 'lockNote' as exception keys to modify and lock these fields.
  • Added lockPurpose and lockNote as available return keys to lock those fields on the reservation UI without raising a conflict / exception to the user.
  • Adding include_cancelled as an option to include cancelled reservations on any of the reservation fetch related functions.

Version 1.7.1 (2024-08-13)

  • Added account_number filter to reservation fetching functions.

Version 1.7.0 (2024-07-05)

  • Added fetch to the users API functions (api.users.fetch)

Version 1.6.6 (2024-06-17)

  • Added account_number_description to the reservation object

Version 1.6.5 (2024-05-09)

  • Removed invoices from the Reservation object as it was never used and slowed down requests

Version 1.6.4 (2024-03-22)

  • Added latest option to the api.reservations.from_reservation_id function

Version 1.6.3 (2024-03-20)

  • Added named_unit to the reservation dictionary

Version 1.6.2 (2024-03-08)

  • Added maintenance and maintenance_nonblocking to the reservation dictionary
  • Added include_maintenance and include_maintenance_nonblocking to the count and fetch functions for reservations.

Version 1.6.1 (2023-08-02)

  • Added reservation_unit_limit to the reservable dictionary

Version 1.6.0 (2023-06-16)

  • Added api.reservations.from_reservation_id.
  • Added api.sites.site_custom_property_from_portal and api.sites.site_user_custom_property.
  • Added datetime.format.
  • Fixed some issues with nested function performance.

Version 1.5.4 (2023-02-21)

  • Added earned_on and performed_by to credential dictionary.

Version 1.5.3 (2022-12-22)

  • Added api.resources.related
  • Added api.resources.for_tag

Version 1.5.2 (2022-08-25)

  • Added hidden_note to project dicts contained in reservations (available in QReserve release 2208.03).

Version 1.5.1 (2022-05-04)

  • Fix api.reservations.count and api.reservations.*_consumed functions so that they return correct values when multi-resource reservations are present.

Version 1.5.0 (2022-03-14)

  • Added api.resources.available and api.resources.temporary_tag.
  • Added util.lists.sublist.
  • Added util.math.ceiling, util.math.floor, and util.math.modulo.
  • Added util.random.choice, util.random.integer, and util.random.shuffle.
  • Added the ability to set resources in the front end booking modal to the Exception system.

Version 1.4.0 (2022-02-23)

  • Added api.forms.form_response_from_form_id_with_evaluated_scripts.
  • Added api.users.from_email and api.users.from_user_id.
  • Fixed bug where isinstance on a datetime would crash.
  • Added reservation/request resource disclaimers using script results.

Version 1.3.0 (2021-12-17)

  • Added api.resources.custom_property.
  • Added util.strings.newline and util.strings.tab.

Version 1.2.1 (2021-12-02)

  • Fixed not being able to cast evaluated expressions to dec and int.
  • Added the ability to shorthand cast string to int and dec using their cast functions.
  • Decimals can now be cast to integers with the int cast function.

Version 1.2.0 (2021-10-26)

  • Added datetime.difference_relative.

Version 1.1.0 (2021-10-13)

  • Added util.dicts.reduce, util.dicts.to_pairs, util.strings.split, and util.strings.to_decimal.

Version 1.0.0

Initial commit. 🐍