Release notes ============= **2025-02-10** * `Lock` extended with new setting: `DoorStateEventLoggingEnabled` - enables/disables the creation of DoorOpened and DoorClosed events from the door sensor in activity logs. The default value is false. **2025-01-27** * Added new API version 1.34. * Device Share area is migrated to the `Device Access area `_. * Device access is returned in `accessDetails` property instead `shareDetails`. * Access restrictions for device access are in :doc:`access details <../../datastructures/access-details>`. * Renamed property from `lockProperties` to `deviceState` in :doc:`Lock <../../datastructures/lock>` model. **2025-01-13** * API Version 1.33 extended with :doc:`Door Sensor Area <../endpoints/doorsensor/index>`. which manages door sensor devices. **2024-12-16** * `Lock` extended with new setting: `AutoLockAfterDoorClosedEnabled` - enables/disables auto-locking after the door is closed. The default value is false. * Added new Event Type: `DoorOpenTooLong`. * Added publishing `BellButtonPressed` event via webhooks for integrations: :doc:`Bell Button Pressed Webhook <../webhooks/bell-button-pressed>`. **2024-11-18** * Endpoint `Device > Transfer ownership `_ extended with `removeExistingShares` parameter. + If set to true, all existing shares will be removed from the transferred devices. **2024-11-04** * Removed `deviceSettings` field from dry contact model. It is no longer possible to configure dry contact by API. + User can configure dry contact using a configuration file in the mobile app. * Endpoint `Device > Transfer ownership `_ allows to transfer ownership of multiple devices at once. + If any devices in the transfer are currently paired with devices outside the transfer request, those pairings will be removed. **2024-10-22** * New endpoint added: `Device > Transfer ownership `_ + The endpoint allows transferring the ownership of the device to another user. + To perform the operation, the user must be the owner of the transferred device. * Fixes: + Exception on `Organization access link > Edit organization access link `_ when changing devices order. **2024-10-07** * endpoint `Lock > Get Accessories `_ extended with `AccessoryType` parameter, which allows filtering accessories by type. * `Keypad` model extended with `deviceState`, which includes information about the device state. Currently, the object contains: + `batteryLevel` - battery level in percentage (returned if no older than 30-days), + `batteryLevelModifiedDateTime` - date and time when the battery level was last modified (returned if no older than 30-days). **2024-09-23** * added API version 1.33, which consists of breaking changes described below: + fields `connectedToDryContactId`, `connectedToKeypadId` removed from `Lock` model. + field `accessories` of type :doc:`Lock Accessory [] <../datastructures/lock-accessory>` added to `Lock` model. + endpoint `Lock > Pair lock with DryContact device `_ removed. + endpoint `Lock > Unpair lock from DryContact device `_ removed. + endpoint `Lock > Pair lock with Keypad device `_ removed. + endpoint `Lock > Unpair lock from Keypad device `_ removed. * New endpoint added: `Lock > Pair Accessory `_. + The endpoint allows pairing accessories to the lock. * add user display name to response from `DeviceShare > Post Bulk `_ endpoint. * added `revision` field to :doc:`Lock > Sync <../../endpoints/lock/sync>` and :doc:`Lock > Sync single <../../endpoints/lock/sync-single>` endpoints. **2024-08-12** * New endpoint added: `Lock > Get Accessories `_. + The endpoint returns a list of accessories that can be paired with the lock. * New endpoint added: `Lock > Unpair Accessory `_. + The endpoint allows unpairing accessories from the lock. * Fix: After linking account with BleBox devices are properly displayed in the Tedee app. **2024-07-15** * `User > Delete account `_ endpoint returns an `HTTP 412 Precondition Failed` status when the user owns an organization. To delete an account, the user must first `delete the owned organization `_. **2024-07-02** * `Organization user > Add user to organization `_ endpoint extended with role property. * Personal access key global rate limit introduced. User can make up to 1000 requests per 1 hour. **2024-06-17** * new `DryContact > Get all `_ endpoint introduced for getting all dry contact devices. * :doc:`Unlock gate <../../endpoints/gate/unlock>` endpoint returns new HTTP statuses: + 412 Precondition Failed - when user doesn't have active BleBox integration + 423 Locked - when gate is disconnected **2024-06-03** * new `DryContact `_ area introduced with CRUD endpoints for managing dry contact devices: + `DryContact > Add DryContact `_ endpoint. + `DryContact > Update DryContact `_ endpoint. + `DryContact > Delete DryContact `_ endpoint. + `DryContact > Get DryContact `_ endpoint. * `Lock` area extended with pair/unpair `DryContact` endpoints: + `Lock > Pair DryContact `_ endpoint. + `Lock > Unpair DryContact `_ endpoint. * :doc:`Lock <../../datastructures/lock>` type extended with `connectedToDryContactId` property. * `Device > Get devices with details `_ endpoint extended with `drycontacts[]` array. **2024-02-19** * added "isAsync" (hotel mode) property to lock :doc:`Device settings <../../datastructures/device-settings>` **2023-11-27** * added "serialNumber", "softwareVersion" and "state" properties to response from `Bridge > Get paired devices `_ endpoint **2023-10-30** * improvements in `Gate > Unlock Gate `_ endpoint. Endpoint now returns `HTTP 408 Request timeout` when connecting to BleBox device ends with timeout. **2023-10-16** * added filters to `Organization > Get organization permission matrix `_ endpoint. The currently available filters are: `Filters.Text` where you can specify user name or email, and `Filters.DeviceId [array]` where you can specify only devices you are interested in. * improved new calibration endpoints `Lock > Calibrare Lock `_ and `Lock > Calibrate Pull Spring `_. If you try calibrating the lock using a new endpoints and your bridge firmware is outdated, you will get an `HTTP 409 Conflict` response. **2023-10-02** * added new API version 1.32 * added new user setting on lock device for canceling auto-unlock by other auto-unlock (autoUnlockCancelOtherAutoUnlock) * added new user setting in user profile for dynamic changing first lock on device list based on user location (dynamicFirstLock) * added new endpoints for lock device calibration * removed old endpoints for lock device calibration **2023-09-18** * added new API version 1.31 * `Organization User > Add user to organization `_ endpoint returns `organizationUserId` in the response body on success * `Organization > Get activities for organization device or user `_ endpoints takes `OrganizationUserId` instead of `UserId` * `Organization User > Get all user organization devices with permissions `_ endpoints takes `OrganizationUserId` instead of `UserId`, `Timezone` added for each device returned in the response body * `Organization User > Get organization user profile `_ endpoints takes `OrganizationUserId` instead of `UserId`, and in addition return `OrganizationUserId`, `UserId`, `Roles` in the response body * added `Organization Device > Return all shares for specific device `_ endpoint **2023-08-07** * extended `OrganizationUser Area > Get all users from organization `_ endpoint with filter to search by name/email and to include pending users * added `IncludeUserSetting` parameter to `Gate Area > Sync single `_ endpoint **2023-07-24** * `Bridge` extended with `LocalApiEnabled` setting * added rate limiter for Get All Locks endpoint for Personal Access Key (10 requests per 10 minutes allowed) * `Organization` endpoints extended with `deviceType` property **2023-07-10:** * added support for `location` in organization access links **2023-06-26:** * extended `Integration Area > Disconnect with BleBox `_ endpoint with possibility to hard delete Gates **2023-06-12:** * `Personal Access Key` authentication enabled on `Integration Area > Update linked BleBox account connection `_ endpoint * remote unlock setting enabled for `Gate` devices * added `Location` property to `Gate` device * `OrganizationAccessLink` description updated to 1000 chars * added `Gate Area > Delete Gate device `_ endpoint * updated `Gate Area > Unlock Gate `_ endpoint: + success operation returns `204 No Content` instead of `200 OK` + endpoint returns no data in response body on success * added cloning `userSettings` in `Device > Clond device data `_ endpoint + `DataToClone` parameter value to clone user settings is `4` **2023-05-29:** * added `Device Area > Clone device data `_ endpoint, which enables cloning device settings, permissions to another device * added `Gate Area > Show all gates assigned to logged user `_ endpoint * added `Integration Area > Sync BleBox Accounts `_ endpoint, which enables synchronization of BleBox accounts with Tedee Cloud * `OrganizationAccessLink` sorted by name in `Organization Access Link Area > Get organization access links `_ endpoint * `Gate` firmware version is returned in `softwareVersions` property * fixes: + guest user can change his user settings with `Gate Area > Update Gate device with entered Id `_ endpoint **2023-05-15:** * updated `OrganizationAccessLink` requirements: + `name` length constrained to 50 chars + `description` length constrained to 500 chars * extended `Gate` models with `Icon` property, which enables settings predefined icon for Gate device **2023-04-10:** * updated `Integration Area > Update linked BleBox account connection `_ endpoint: + user can optionally set the `organizationId` parameter to assign all devices from the BleBox account to the organization * fixes: + `userEmail` property is validated on `DeviceShare` creating **2023-03-27:** * added a new API version 1.30 * added organization access links management endpoints **2022-12-05:** * added a new API version 1.29 * changed HoldToUnlock user setting type to enum **2022-08-16:** * added a new API version 1.28 * removed old organization endpoints * unified schema of organization/device area **2022-07-18:** * added a new API version 1.27 * removed unlocked notification from global user settings **2022-06-20:** * added a new API version 1.26 * added support for device notification settings * added paging and filtering to my/lock endpoint * added IncludeOrganization parameter to my/lock endpoint **2022-02-28:** * added new user setting on lock device for WiFi checking in auto-unlock **2022-01-31:** * added new keypad device setting for enable/disable lock action by keypad button * added new events to device activity logs (LockedByKeypadWithPin and LockedByKeypadWithoutPin) **2022-01-17:** * removed API version 1.9 * added automatic keypad pairing with bridge when keypad is paired with lock **2021-12-20:** * added a new API version 1.25 * added new keypad device setting with battery type * added restriction for sound volume values in keypad **2021-11-22:** * added a new API version 1.24 * added new keypad device setting for enable/disable bell button **2021-11-08:** * added a new API version 1.23 * changed data type of mobile device identifier from int to guid **2021-10-25:** * added "Other" operating system in POST mobile endpoint **2021-10-11:** * added timezone validation for devices * added endpoints for keypad pin list management * added request rate limit in lock sync endpoints * added "my" prefix in personal access key endpoints * sending e-mail after creating personal access key **2021-09-27:** * added a new API version 1.22 * removed "accessType" property from POST/PATCH endpoints for device share * max expiration date for personal access key set to 5 years * changed default mode in unlock operation to "not pull" and added new "unlock or pull spring" mode, which allows to perform pull when lock is in unlocked state **2021-09-13:** * added user authentication based on personal access key * allowed to set recurring device share only with start/end times or week days **2021-08-30:** * added a new API version 1.21 * fixed issue with deleting bridge **2021-08-16:** * added a new API version 1.20 * endpoints for lock/unlock/pull operations refactored to have all parameters in path instead of in body * added "without auto pull spring" mode in unlock operation endpoint **2021-08-02:** * endpoints for pairing/unpairing keypad with lock moved to Lock area * added information about keypad paired with lock ("connectedToKeypadId" property in Lock type) **2021-06-21:** * added endpoints to pair/unpair keypad with lock * added timezone for keypad device * fix: cannot remove device share when device is in organization **2021-06-07:** * added endpoints to manage keypad devices **2021-05-24:** * added a new API version 1.19 * added timezone for lock and bridge devices * removed PUT endpoint and added PATCH endpoint to bridge update **2021-05-10:** * added a new API version 1.18 * removed "unregister" endpoint from StandardNotificationHub **2021-04-26:** * added a new API version 1.17 * added endpoint to check close/open/pull operation status * changed response for close/open/pull operation request (added "lastStateChangedDate" and changed result code to 202 Accepted) * added "lastStateChangedDate" and "stateChangeResult" to all endpoints returning Lock state **2021-01-18:** * added a new API version 1.16 * all user settings moved to a new "userSettings" property in the Lock type * removed "bridgeId" property from the Lock type * removed "connectedToId", "iotDeviceName" and "voipNumber" properties from Bridge type **2020-12-07:** * removed API versions 1.10, 1.11 and 1.12 * added information about an ongoing bridge software update * lock state returned as an enum **2020-11-23:** * scopes applied to all API endpoints * added new endpoints for lock synchronization * API versions in swagger sorted in descending order