completed merge of #258 , contributed by @mvarian

Merge branch 'main' of github.com:Art-of-WiFi/UniFi-API-client into main
merge #258 and review
2024-12-19 10:55:53 +01:00 · 2024-12-19 10:39:33 +01:00 · 2024-12-19 10:39:10 +01:00 · 2024-11-24 11:58:49 +01:00 · 2024-11-15 10:33:11 +01:00 · 2024-11-15 10:31:10 +01:00
2 changed files with 290 additions and 199 deletions
--- a/README.md
+++ b/README.md
@@ -2,16 +2,19 @@

 A PHP class that provides access to Ubiquiti's [**UniFi Network Application**](https://unifi-network.ui.com/) API.

-UniFi Network Application software versions 5.X.X, 6.X.X, 7.X.X, and 8.X.X (version **8.5.2** has been confirmed to
-work) are supported as well as Network Applications on **UniFi OS-based consoles** (UniFi OS **4.0.20** has been
-confirmed to work).
-
 This class is used by our API Browser tool, which can be found
 [here](https://github.com/Art-of-WiFi/UniFi-API-browser).

 The package can be installed manually or by using
 composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for
-easy inclusion in your projects.
+easy inclusion in your projects. See the [installation instructions](#Installation) below for more details.
+
+## Supported Versions
+
+| Software                             | Versions                                            |
+|--------------------------------------|-----------------------------------------------------|
+| UniFi Network Application/controller | 5.X.X, 6.X.X, 7.X.X, 8.X.X (**8.5.6 is confirmed**) |
+| UniFi OS                             | 3.X, 4.X (**4.1.15 is confirmed**)                  |


 ## Requirements
@@ -29,17 +32,19 @@ easy inclusion in your projects.

 ## UniFi OS Support

-Support for UniFi OS-based controllers has been added as of version 1.1.47. These devices have been verified to work:
+Support for UniFi OS-based controllers has been added as of version 1.1.47. These devices/services have been verified
+to work:
 - UniFi Dream Router (UDR)
 - UniFi Dream Machine (UDM)
 - UniFi Dream Machine Pro (UDM PRO)
 - UniFi Cloud Key Gen2 (UCK G2), firmware version 2.0.24 or higher
 - UniFi Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
- UniFi Cloud Console, details [here](https://help.ui.com/hc/en-us/articles/4415364143511)
 - UniFi Express (UX)
 - UniFi Dream Wall (UDW)
 - UniFi Cloud Gateway Ultra (UCG-Ultra)
+- UniFi CloudKey Enterprise (CK-Enterprise)
 - UniFi Enterprise Fortress Gateway (EFG)
+- Official UniFi Hosting, details [here](https://help.ui.com/hc/en-us/articles/4415364143511)

 The class automatically detects UniFi OS consoles and adjusts the URLs and several functions/methods accordingly.

--- a/src/Client.php
+++ b/src/Client.php
Author	SHA1	Message	Date
malle-pietje	d722d7b843	completed merge of #258 , contributed by @mvarian	2024-12-19 10:55:53 +01:00
malle-pietje	3cf7b4d173	Merge branch 'main' of github.com:Art-of-WiFi/UniFi-API-client into main merge #258 and review	2024-12-19 10:39:33 +01:00
Michael Varian	6b230753a0	Fix for implicit null declarations resulting in PHP 8.4+ warnings (#258 ) Merge #258	2024-12-19 10:39:10 +01:00
malle-pietje	97510ec5ec	prepared new version number	2024-11-24 11:58:49 +01:00
malle-pietje	9726378e3c	bumped version to 1.1.101	2024-11-15 10:33:11 +01:00
malle-pietje	494375f8b5	- added a private property $cookies_created_at to store the timestamp when the cookies were created/updated. - added a getter method get_cookies_created_at() to return the timestamp when the cookies were created/updated. This information can be useful to determine how old the cookies are. - minor comments clean up	2024-11-15 10:31:10 +01:00
malle-pietje	3dbc24daca	further tweaks	2024-11-04 13:43:57 +01:00
malle-pietje	93d1d8ec3f	tweaked hyperlink	2024-11-04 13:38:18 +01:00
malle-pietje	b8620f7672	changed link to hyperlink	2024-11-04 13:37:01 +01:00
malle-pietje	1e2e709d4a	inserted link to installation instructions	2024-11-04 13:34:41 +01:00
malle-pietje	472d2eaa68	restructured and updated supported versions info	2024-11-04 13:32:34 +01:00
malle-pietje	1522992e49	bumped version to 1.1.100 fixed incorrect return type for `create_voucher()`, reported by @pa-	2024-10-29 12:14:00 +01:00
malle-pietje	70f6a374e2	- added get_system_log() method to get data from the system logs, returns pages results - minor formatting changes	2024-10-23 13:30:34 +02:00
malle-pietje	ff9e6f0225	merged #244 for a small change to the `start_rolling_upgrade()` method, contributed by @Jacobtims minor additional change to allow changes to the payload of the `start_rolling_upgrade()` method	2024-10-17 16:41:45 +02:00
Jacob Timmerman	00a637dbc4	Add "uxg" to start_rolling_upgrade payload (#244 ) * Fix payload start_rolling_upgrade method * Add "uxg" to start_rolling_upgrade payload	2024-10-17 16:31:25 +02:00
malle-pietje	6498b0255b	Merge branch 'master' of github.com:Art-of-WiFi/UniFi-API-client merging #243	2024-10-17 14:56:47 +02:00
malle-pietje	05e791bcf0	minor changes	2024-10-17 14:56:36 +02:00
Jacob Timmerman	192a1262c3	Fix payload start_rolling_upgrade method (#243 )	2024-10-17 14:55:54 +02:00
malle-pietje	30056f50fc	- bumped version to 1.1.96 - removed @version tag in docblock as it contained redundant information - merged #241 which adds a method to download a generated backup, (contributed by @Jacobtims)	2024-10-14 14:34:48 +02:00
Jacob Timmerman	d040c512a7	Add method to download generated backup (#241 ) Merged PR #241	2024-10-14 14:31:44 +02:00