diff --git a/docs/services/Call/Call.md b/docs/services/Call/Call.md
index 43c358e..e0ba953 100644
--- a/docs/services/Call/Call.md
+++ b/docs/services/Call/Call.md
@@ -5,11 +5,11 @@
# Overview
- [Contact](./Contact/Contact.md)
- - [ContactAddress](Contact/Contact.md#ContactAddress)
- - [ContactEmail](Contact/Contact.md#ContactEmail)
- - [ContactEntry](Contact/Contact.md#ContactEntry)
- - [ContactNumber](Contact/Contact.md#ContactNumber)
- - [ContactUrl](Contact/Contact.md#ContactUrl)
+ - [ContactNumber](Contact/Contact.md#ContactNumber)
+ - [ContactAddress](Contact/Contact.md#ContactAddress)
+ - [ContactUrl](Contact/Contact.md#ContactUrl)
+ - [ContactEmail](Contact/Contact.md#ContactEmail)
+ - [ContactEntry](Contact/Contact.md#ContactEntry)
- [CallEntry](Call.md#CallEntry)
diff --git a/docs/services/Call/Contact/Contact.md b/docs/services/Call/Contact/Contact.md
index a6bee8a..424a8c6 100644
--- a/docs/services/Call/Contact/Contact.md
+++ b/docs/services/Call/Contact/Contact.md
@@ -4,13 +4,28 @@
# Overview
+- [ContactNumber](Contact.md#ContactNumber)
- [ContactAddress](Contact.md#ContactAddress)
+- [ContactUrl](Contact.md#ContactUrl)
- [ContactEmail](Contact.md#ContactEmail)
- [ContactEntry](Contact.md#ContactEntry)
-- [ContactNumber](Contact.md#ContactNumber)
-- [ContactUrl](Contact.md#ContactUrl)
+
+## ContactNumber
+
+**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactNumber
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getFromId` | Get the contact number (with the given id) |
+| `create` | Add a new contact number |
+| `delete` | Remove a contact number |
+| `deleteFromId` | Remove a contact number (with the specified id) |
+| `update` | Update a contact number |
+
## ContactAddress
@@ -26,6 +41,21 @@
| `deleteFromId` | Remove an address (with the given id) |
| `update` | Update an address |
+
+## ContactUrl
+
+**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactUrl
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getFromId` | Get the contact url (with the given id) |
+| `create` | Add a new contact url |
+| `delete` | Remove a contact url |
+| `deleteFromId` | Remove a contact url (with the given id) |
+| `update` | Update a contact url |
+
## ContactEmail
@@ -60,33 +90,3 @@
| `getContactAddressesFromContactId` | Get all addresses associated to a given contact id |
| `getContactEmailsFromContactId` | Get all email addresses associated to a given contact id |
| `getContactUrlsFromContactId` | Get all URLs associated to a given contact id |
-
-
-## ContactNumber
-
-**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactNumber
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getFromId` | Get the contact number (with the given id) |
-| `create` | Add a new contact number |
-| `delete` | Remove a contact number |
-| `deleteFromId` | Remove a contact number (with the specified id) |
-| `update` | Update a contact number |
-
-
-## ContactUrl
-
-**Class** : alphayax\freebox\api\v3\services\Call\Contact\ContactUrl
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getFromId` | Get the contact url (with the given id) |
-| `create` | Add a new contact url |
-| `delete` | Remove a contact url |
-| `deleteFromId` | Remove a contact url (with the given id) |
-| `update` | Update a contact url |
diff --git a/docs/services/FileSystem/FileSystem.md b/docs/services/FileSystem/FileSystem.md
index 4d27792..967b024 100644
--- a/docs/services/FileSystem/FileSystem.md
+++ b/docs/services/FileSystem/FileSystem.md
@@ -4,13 +4,25 @@
# Overview
-- [FileSharingLink](FileSystem.md#FileSharingLink)
- [FileSystemListing](FileSystem.md#FileSystemListing)
-- [FileSystemOperation](FileSystem.md#FileSystemOperation)
+- [FileSharingLink](FileSystem.md#FileSharingLink)
- [FileSystemTask](FileSystem.md#FileSystemTask)
- [FileUpload](FileSystem.md#FileUpload)
+- [FileSystemOperation](FileSystem.md#FileSystemOperation)
+
+## FileSystemListing
+
+**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemListing
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getFilesFromDirectory` | Get all files in a given directory |
+| `getFileInformation` | Get file information |
+
## FileSharingLink
@@ -25,40 +37,6 @@
| `deleteFromToken` | Delete a File Sharing link for his token identifier Deletes the ShareLink task with the given token, if the task was running, stop it. |
| `create` | Create a File Sharing link |
-
-## FileSystemListing
-
-**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemListing
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getFilesFromDirectory` | Get all files in a given directory |
-| `getFileInformation` | Get file information |
-
-
-## FileSystemOperation
-
-**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemOperation
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `move` | Move files |
-| `copy` | Copy files |
-| `remove` | Delete files |
-| `cat` | Concatenate files (Miaw ^^) |
-| `archive` | Create an archive |
-| `extract` | Extract an archive |
-| `repair` | Repair files from a .par2 |
-| `computeHash` | Hash a file. This operation can take some time. To get the hash value, the returned task must have succeed and be in the state “done”. |
-| `getHashValue` | Get the hash value To get the hash, the task must have succeed and be in the state “done”. |
-| `createDirectory` | Create a directory Contrary to other file system tasks, this operation is done synchronously. |
-| `rename` | Rename a file/folder Contrary to other file system tasks, this operation is done synchronously. |
-| `download` | Download a file from the freebox server (return the file content) |
-
## FileSystemTask
@@ -90,3 +68,25 @@
| `cancelFromId` | Cancel the given FileUpload closing the connection The upload status must be in_progress |
| `deleteFromId` | Delete the given FileUpload closing the connection if needed |
| `cleanTerminated` | Deletes all the FileUpload not in_progress |
+
+
+## FileSystemOperation
+
+**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemOperation
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `move` | Move files |
+| `copy` | Copy files |
+| `remove` | Delete files |
+| `cat` | Concatenate files (Miaw ^^) |
+| `archive` | Create an archive |
+| `extract` | Extract an archive |
+| `repair` | Repair files from a .par2 |
+| `computeHash` | Hash a file. This operation can take some time. To get the hash value, the returned task must have succeed and be in the state “done”. |
+| `getHashValue` | Get the hash value To get the hash, the task must have succeed and be in the state “done”. |
+| `createDirectory` | Create a directory Contrary to other file system tasks, this operation is done synchronously. |
+| `rename` | Rename a file/folder Contrary to other file system tasks, this operation is done synchronously. |
+| `download` | Download a file from the freebox server (return the file content) |
diff --git a/docs/services/ParentalControl/ParentalControl.md b/docs/services/ParentalControl/ParentalControl.md
index 04d689b..6a5a63a 100644
--- a/docs/services/ParentalControl/ParentalControl.md
+++ b/docs/services/ParentalControl/ParentalControl.md
@@ -4,10 +4,22 @@
# Overview
-- [Filter](ParentalControl.md#Filter)
- [FilterPlanning](ParentalControl.md#FilterPlanning)
+- [Filter](ParentalControl.md#Filter)
+
+## FilterPlanning
+
+**Class** : alphayax\freebox\api\v3\services\ParentalControl\FilterPlanning
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getFromFilterId` | Get the filer planning associated with the given filter id |
+| `setFromFilterId` | Update the filer planning associated with the given filter id |
+
## Filter
@@ -25,15 +37,3 @@
| `delete` | Delete a filter |
| `deleteFromId` | Delete a filter with the specified id |
| `add` | Add a new filter |
-
-
-## FilterPlanning
-
-**Class** : alphayax\freebox\api\v3\services\ParentalControl\FilterPlanning
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getFromFilterId` | Get the filer planning associated with the given filter id |
-| `setFromFilterId` | Update the filer planning associated with the given filter id |
diff --git a/docs/services/config/Connection/Connection.md b/docs/services/config/Connection/Connection.md
index 21f68b6..68daca8 100644
--- a/docs/services/config/Connection/Connection.md
+++ b/docs/services/config/Connection/Connection.md
@@ -5,30 +5,15 @@
# Overview
- [DynDns](./DynDns/DynDns.md)
- - [DynDns](DynDns/DynDns.md#DynDns)
- - [NoIP](DynDns/DynDns.md#NoIP)
- - [Ovh](DynDns/DynDns.md#Ovh)
-- [Connection](Connection.md#Connection)
+ - [DynDns](DynDns/DynDns.md#DynDns)
+ - [NoIP](DynDns/DynDns.md#NoIP)
+ - [Ovh](DynDns/DynDns.md#Ovh)
- [DynDns](Connection.md#DynDns)
- [Ftth](Connection.md#Ftth)
+- [Connection](Connection.md#Connection)
- [Xdsl](Connection.md#Xdsl)
-
-## Connection
-
-**Class** : alphayax\freebox\api\v3\services\config\Connection\Connection
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getStatus` | Get the current Connection status |
-| `getConfiguration` | Get the current Connection configuration |
-| `setConfiguration` | Get the current Connection configuration |
-| `getIPv6Configuration` | Get the current IPv6 Connection configuration |
-| `setIPv6Configuration` | Update the IPv6 Connection configuration |
-
## DynDns
@@ -53,6 +38,21 @@
|---|---|
| `getStatus` | Get the current Connection status |
+
+## Connection
+
+**Class** : alphayax\freebox\api\v3\services\config\Connection\Connection
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getStatus` | Get the current Connection status |
+| `getConfiguration` | Get the current Connection configuration |
+| `setConfiguration` | Get the current Connection configuration |
+| `getIPv6Configuration` | Get the current IPv6 Connection configuration |
+| `setIPv6Configuration` | Update the IPv6 Connection configuration |
+
## Xdsl
diff --git a/docs/services/config/LAN/LAN.md b/docs/services/config/LAN/LAN.md
index 5add3c6..2111d03 100644
--- a/docs/services/config/LAN/LAN.md
+++ b/docs/services/config/LAN/LAN.md
@@ -4,10 +4,22 @@
# Overview
-- [Browser](LAN.md#Browser)
- [LAN](LAN.md#LAN)
+- [Browser](LAN.md#Browser)
+
+## LAN
+
+**Class** : alphayax\freebox\api\v3\services\config\LAN\LAN
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getConfiguration` | Get the current LAN configuration |
+| `setConfiguration` | Update the LAN configuration |
+
## Browser
@@ -23,15 +35,3 @@
| `getHostFromId` | Get a specific LanHost |
| `updateHostFromInterfaceId` | Update a LanHost |
| `wakeOnLan` | Send Wake ok Lan packet to an host |
-
-
-## LAN
-
-**Class** : alphayax\freebox\api\v3\services\config\LAN\LAN
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getConfiguration` | Get the current LAN configuration |
-| `setConfiguration` | Update the LAN configuration |
diff --git a/docs/services/config/NAT/NAT.md b/docs/services/config/NAT/NAT.md
index bcb4733..77f7d45 100644
--- a/docs/services/config/NAT/NAT.md
+++ b/docs/services/config/NAT/NAT.md
@@ -4,11 +4,27 @@
# Overview
+- [PortForwarding](NAT.md#PortForwarding)
- [DMZ](NAT.md#DMZ)
- [IncomingPort](NAT.md#IncomingPort)
-- [PortForwarding](NAT.md#PortForwarding)
+
+## PortForwarding
+
+**Class** : alphayax\freebox\api\v3\services\config\NAT\PortForwarding
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getAll` | Getting the list of port forwarding |
+| `getById` | Getting a specific port forwarding |
+| `update` | Update a specific port forwarding |
+| `add` | Add a port forwarding |
+| `delete` | Delete a port forwarding |
+| `deleteById` | Delete a port forwarding with the specified id |
+
## DMZ
@@ -33,19 +49,3 @@
| `getAll` | Getting the list of incoming ports |
| `getFromId` | Getting a specific incoming port |
| `update` | Updating an incoming port |
-
-
-## PortForwarding
-
-**Class** : alphayax\freebox\api\v3\services\config\NAT\PortForwarding
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getAll` | Getting the list of port forwarding |
-| `getById` | Getting a specific port forwarding |
-| `update` | Update a specific port forwarding |
-| `add` | Add a port forwarding |
-| `delete` | Delete a port forwarding |
-| `deleteById` | Delete a port forwarding with the specified id |
diff --git a/docs/services/config/SwitchPort/SwitchPort.md b/docs/services/config/SwitchPort/SwitchPort.md
index 8928a0c..ae304a6 100644
--- a/docs/services/config/SwitchPort/SwitchPort.md
+++ b/docs/services/config/SwitchPort/SwitchPort.md
@@ -4,22 +4,21 @@
# Overview
-- [Config](SwitchPort.md#Config)
-- [Stats](SwitchPort.md#Stats)
- [Status](SwitchPort.md#Status)
+- [Stats](SwitchPort.md#Stats)
+- [Config](SwitchPort.md#Config)
-
-## Config
+
+## Status
-**Class** : alphayax\freebox\api\v3\services\config\SwitchPort\Config
+**Class** : alphayax\freebox\api\v3\services\config\SwitchPort\Status
### Public methods
| Method | Description |
|---|---|
-| `getFromPortId` | Get a port configuration |
-| `update` | Update a port configuration |
+| `getStatus` | Get the current switch status |
## Stats
@@ -32,13 +31,14 @@
|---|---|
| `getFromPortId` | Get a port configuration |
-
-## Status
+
+## Config
-**Class** : alphayax\freebox\api\v3\services\config\SwitchPort\Status
+**Class** : alphayax\freebox\api\v3\services\config\SwitchPort\Config
### Public methods
| Method | Description |
|---|---|
-| `getStatus` | Get the current switch status |
+| `getFromPortId` | Get a port configuration |
+| `update` | Update a port configuration |
diff --git a/docs/services/config/UPnP/UPnP.md b/docs/services/config/UPnP/UPnP.md
index a4019d0..1d529a1 100644
--- a/docs/services/config/UPnP/UPnP.md
+++ b/docs/services/config/UPnP/UPnP.md
@@ -4,22 +4,10 @@
# Overview
-- [AV](UPnP.md#AV)
- [IGD](UPnP.md#IGD)
+- [AV](UPnP.md#AV)
-
-## AV
-
-**Class** : alphayax\freebox\api\v3\services\config\UPnP\AV
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getConfiguration` | Get the current UPnP AV configuration |
-| `setConfiguration` | Update the UPnP AV configuration |
-
## IGD
@@ -33,3 +21,15 @@
| `setConfiguration` | Update the UPnP AV configuration |
| `getRedirections` | Get the list of current redirection |
| `deleteRedirectionFromId` | Delete a redirection |
+
+
+## AV
+
+**Class** : alphayax\freebox\api\v3\services\config\UPnP\AV
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getConfiguration` | Get the current UPnP AV configuration |
+| `setConfiguration` | Update the UPnP AV configuration |
diff --git a/docs/services/config/VPN/Client/Client.md b/docs/services/config/VPN/Client/Client.md
index 0886ff6..d92efac 100644
--- a/docs/services/config/VPN/Client/Client.md
+++ b/docs/services/config/VPN/Client/Client.md
@@ -4,10 +4,22 @@
# Overview
-- [Config](Client.md#Config)
- [Status](Client.md#Status)
+- [Config](Client.md#Config)
+
+## Status
+
+**Class** : alphayax\freebox\api\v3\services\config\VPN\Client\Status
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getStatus` | Get the VPN client status |
+| `getLogs` | Get the VPN client Logs |
+
## Config
@@ -23,15 +35,3 @@
| `delete` | |
| `deleteFromId` | |
| `update` | |
-
-
-## Status
-
-**Class** : alphayax\freebox\api\v3\services\config\VPN\Client\Status
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getStatus` | Get the VPN client status |
-| `getLogs` | Get the VPN client Logs |
diff --git a/docs/services/config/VPN/Server/Server.md b/docs/services/config/VPN/Server/Server.md
index 7dc93e7..97894e9 100644
--- a/docs/services/config/VPN/Server/Server.md
+++ b/docs/services/config/VPN/Server/Server.md
@@ -4,47 +4,12 @@
# Overview
-- [Config](Server.md#Config)
-- [Connection](Server.md#Connection)
-- [IpPool](Server.md#IpPool)
- [User](Server.md#User)
+- [IpPool](Server.md#IpPool)
+- [Connection](Server.md#Connection)
+- [Config](Server.md#Config)
-
-## Config
-
-**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\Config
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getConfigurationFromId` | Get a VPN config |
-| `setConfiguration` | Update the VPN configuration |
-
-
-## Connection
-
-**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\Connection
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getAll` | Get the list of connections |
-| `closeFromId` | Close a given connection |
-
-
-## IpPool
-
-**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\IpPool
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getReservations` | Get the VPN server IP pool reservations |
-
## User
@@ -61,3 +26,38 @@
| `deleteFromLogin` | Deletes the VPNUser with the given id |
| `update` | Update a VPN Use |
| `getConfigurationFile` | Generate a new configuration file & download it |
+
+
+## IpPool
+
+**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\IpPool
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getReservations` | Get the VPN server IP pool reservations |
+
+
+## Connection
+
+**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\Connection
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getAll` | Get the list of connections |
+| `closeFromId` | Close a given connection |
+
+
+## Config
+
+**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\Config
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getConfigurationFromId` | Get a VPN config |
+| `setConfiguration` | Update the VPN configuration |
diff --git a/docs/services/config/VPN/VPN.md b/docs/services/config/VPN/VPN.md
index 044a6d9..eb21768 100644
--- a/docs/services/config/VPN/VPN.md
+++ b/docs/services/config/VPN/VPN.md
@@ -4,12 +4,12 @@
# Overview
-- [Client](./Client/Client.md)
- - [Config](Client/Client.md#Config)
- - [Status](Client/Client.md#Status)
- [Server](./Server/Server.md)
- - [Config](Server/Server.md#Config)
- - [Connection](Server/Server.md#Connection)
- - [IpPool](Server/Server.md#IpPool)
- - [User](Server/Server.md#User)
+ - [User](Server/Server.md#User)
+ - [IpPool](Server/Server.md#IpPool)
+ - [Connection](Server/Server.md#Connection)
+ - [Config](Server/Server.md#Config)
+- [Client](./Client/Client.md)
+ - [Status](Client/Client.md#Status)
+ - [Config](Client/Client.md#Config)
diff --git a/docs/services/config/WiFi/WiFi.md b/docs/services/config/WiFi/WiFi.md
index 5cabd80..404dc00 100644
--- a/docs/services/config/WiFi/WiFi.md
+++ b/docs/services/config/WiFi/WiFi.md
@@ -4,13 +4,67 @@
# Overview
-- [AccessPoint](WiFi.md#AccessPoint)
-- [Bss](WiFi.md#Bss)
-- [Config](WiFi.md#Config)
-- [MacFilter](WiFi.md#MacFilter)
- [Planning](WiFi.md#Planning)
+- [MacFilter](WiFi.md#MacFilter)
+- [Config](WiFi.md#Config)
+- [Bss](WiFi.md#Bss)
+- [AccessPoint](WiFi.md#AccessPoint)
+
+## Planning
+
+**Class** : alphayax\freebox\api\v3\services\config\WiFi\Planning
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getPlanning` | Get the wifi planning |
+| `update` | Update the wifi planning |
+
+
+## MacFilter
+
+**Class** : alphayax\freebox\api\v3\services\config\WiFi\MacFilter
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getAll` | Get all MacFilters |
+| `getFromId` | Get a specific MacFilter |
+| `update` | Update a MacFilter |
+| `delete` | Delete a MacFilter |
+| `deleteFromId` | Delete a MacFilter with the specified id |
+| `add` | Add a new MacFilter |
+
+
+## Config
+
+**Class** : alphayax\freebox\api\v3\services\config\WiFi\Config
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getConfiguration` | Get the global wifi configuration |
+| `setConfiguration` | Update the global wifi configuration |
+| `resetConfiguration` | Reset Wifi to default configuration |
+
+
+## Bss
+
+**Class** : alphayax\freebox\api\v3\services\config\WiFi\Bss
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getAll` | Get the list of Freebox BSS |
+| `getFromId` | Get a specific BSS |
+| `update` | Update a BSS |
+
## AccessPoint
@@ -28,57 +82,3 @@
| `getNeighborsFromId` | Get the list of Neighbor seen by the AP |
| `refreshNeighborsScan` | WARNING during the scan the AP will be unavailable. Therefore, you should ask for user confirmation prior to launching a scan. Once launched you should wait until the ap state comes back from scanning to get updated info. |
| `getChannelUsageFromId` | List Wi-Fi channels usage |
-
-
-## Bss
-
-**Class** : alphayax\freebox\api\v3\services\config\WiFi\Bss
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getAll` | Get the list of Freebox BSS |
-| `getFromId` | Get a specific BSS |
-| `update` | Update a BSS |
-
-
-## Config
-
-**Class** : alphayax\freebox\api\v3\services\config\WiFi\Config
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getConfiguration` | Get the global wifi configuration |
-| `setConfiguration` | Update the global wifi configuration |
-| `resetConfiguration` | Reset Wifi to default configuration |
-
-
-## MacFilter
-
-**Class** : alphayax\freebox\api\v3\services\config\WiFi\MacFilter
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getAll` | Get all MacFilters |
-| `getFromId` | Get a specific MacFilter |
-| `update` | Update a MacFilter |
-| `delete` | Delete a MacFilter |
-| `deleteFromId` | Delete a MacFilter with the specified id |
-| `add` | Add a new MacFilter |
-
-
-## Planning
-
-**Class** : alphayax\freebox\api\v3\services\config\WiFi\Planning
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getPlanning` | Get the wifi planning |
-| `update` | Update the wifi planning |
diff --git a/docs/services/config/config.md b/docs/services/config/config.md
index a3576fc..34ce425 100644
--- a/docs/services/config/config.md
+++ b/docs/services/config/config.md
@@ -4,66 +4,54 @@
# Overview
-- [Connection](./Connection/Connection.md)
- - [DynDns](./Connection/DynDns/DynDns.md)
- - [DynDns](Connection/DynDns/DynDns.md#DynDns)
- - [NoIP](Connection/DynDns/DynDns.md#NoIP)
- - [Ovh](Connection/DynDns/DynDns.md#Ovh)
- - [Connection](Connection/Connection.md#Connection)
- - [DynDns](Connection/Connection.md#DynDns)
- - [Ftth](Connection/Connection.md#Ftth)
- - [Xdsl](Connection/Connection.md#Xdsl)
- [LAN](./LAN/LAN.md)
- - [Browser](LAN/LAN.md#Browser)
- - [LAN](LAN/LAN.md#LAN)
-- [NAT](./NAT/NAT.md)
- - [DMZ](NAT/NAT.md#DMZ)
- - [IncomingPort](NAT/NAT.md#IncomingPort)
- - [PortForwarding](NAT/NAT.md#PortForwarding)
-- [NetworkShare](./NetworkShare/NetworkShare.md)
- - [Afp](NetworkShare/NetworkShare.md#Afp)
- - [Samba](NetworkShare/NetworkShare.md#Samba)
+ - [LAN](LAN/LAN.md#LAN)
+ - [Browser](LAN/LAN.md#Browser)
- [SwitchPort](./SwitchPort/SwitchPort.md)
- - [Config](SwitchPort/SwitchPort.md#Config)
- - [Stats](SwitchPort/SwitchPort.md#Stats)
- - [Status](SwitchPort/SwitchPort.md#Status)
-- [UPnP](./UPnP/UPnP.md)
- - [AV](UPnP/UPnP.md#AV)
- - [IGD](UPnP/UPnP.md#IGD)
+ - [Status](SwitchPort/SwitchPort.md#Status)
+ - [Stats](SwitchPort/SwitchPort.md#Stats)
+ - [Config](SwitchPort/SwitchPort.md#Config)
- [VPN](./VPN/VPN.md)
- - [Client](./VPN/Client/Client.md)
- - [Config](VPN/Client/Client.md#Config)
- - [Status](VPN/Client/Client.md#Status)
- - [Server](./VPN/Server/Server.md)
- - [Config](VPN/Server/Server.md#Config)
- - [Connection](VPN/Server/Server.md#Connection)
- - [IpPool](VPN/Server/Server.md#IpPool)
- - [User](VPN/Server/Server.md#User)
+ - [Server](./VPN/Server/Server.md)
+ - [User](VPN/Server/Server.md#User)
+ - [IpPool](VPN/Server/Server.md#IpPool)
+ - [Connection](VPN/Server/Server.md#Connection)
+ - [Config](VPN/Server/Server.md#Config)
+ - [Client](./VPN/Client/Client.md)
+ - [Status](VPN/Client/Client.md#Status)
+ - [Config](VPN/Client/Client.md#Config)
+- [UPnP](./UPnP/UPnP.md)
+ - [IGD](UPnP/UPnP.md#IGD)
+ - [AV](UPnP/UPnP.md#AV)
+- [NetworkShare](./NetworkShare/NetworkShare.md)
+ - [Afp](NetworkShare/NetworkShare.md#Afp)
+ - [Samba](NetworkShare/NetworkShare.md#Samba)
- [WiFi](./WiFi/WiFi.md)
- - [AccessPoint](WiFi/WiFi.md#AccessPoint)
- - [Bss](WiFi/WiFi.md#Bss)
- - [Config](WiFi/WiFi.md#Config)
- - [MacFilter](WiFi/WiFi.md#MacFilter)
- - [Planning](WiFi/WiFi.md#Planning)
-- [DHCP](config.md#DHCP)
+ - [Planning](WiFi/WiFi.md#Planning)
+ - [MacFilter](WiFi/WiFi.md#MacFilter)
+ - [Config](WiFi/WiFi.md#Config)
+ - [Bss](WiFi/WiFi.md#Bss)
+ - [AccessPoint](WiFi/WiFi.md#AccessPoint)
+- [Connection](./Connection/Connection.md)
+ - [DynDns](./Connection/DynDns/DynDns.md)
+ - [DynDns](Connection/DynDns/DynDns.md#DynDns)
+ - [NoIP](Connection/DynDns/DynDns.md#NoIP)
+ - [Ovh](Connection/DynDns/DynDns.md#Ovh)
+ - [DynDns](Connection/Connection.md#DynDns)
+ - [Ftth](Connection/Connection.md#Ftth)
+ - [Connection](Connection/Connection.md#Connection)
+ - [Xdsl](Connection/Connection.md#Xdsl)
+- [NAT](./NAT/NAT.md)
+ - [PortForwarding](NAT/NAT.md#PortForwarding)
+ - [DMZ](NAT/NAT.md#DMZ)
+ - [IncomingPort](NAT/NAT.md#IncomingPort)
- [FTP](config.md#FTP)
-- [Freeplug](config.md#Freeplug)
-- [LCD](config.md#LCD)
- [System](config.md#System)
+- [LCD](config.md#LCD)
+- [DHCP](config.md#DHCP)
+- [Freeplug](config.md#Freeplug)
-
-## DHCP
-
-**Class** : alphayax\freebox\api\v3\services\config\DHCP
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getConfiguration` | Get the current DHCP configuration |
-| `setConfiguration` | Update the DHCP configuration |
-
## FTP
@@ -76,18 +64,17 @@
| `getConfiguration` | Get the current FTP configuration |
| `setConfiguration` | |
-
-## Freeplug
+
+## System
-**Class** : alphayax\freebox\api\v3\services\config\Freeplug
+**Class** : alphayax\freebox\api\v3\services\config\System
### Public methods
| Method | Description |
|---|---|
-| `getNetworks` | Get the freeplug networks information |
-| `getFromId` | Get a particular Freeplug information |
-| `resetFromId` | Reset a Freeplug |
+| `getConfiguration` | Get the current system info |
+| `reboot` | Reboot the Freebox |
## LCD
@@ -101,14 +88,27 @@
| `getConfiguration` | Get the current LCD configuration |
| `setConfiguration` | Update the LCD configuration |
-
-## System
+
+## DHCP
-**Class** : alphayax\freebox\api\v3\services\config\System
+**Class** : alphayax\freebox\api\v3\services\config\DHCP
### Public methods
| Method | Description |
|---|---|
-| `getConfiguration` | Get the current system info |
-| `reboot` | Reboot the Freebox |
+| `getConfiguration` | Get the current DHCP configuration |
+| `setConfiguration` | Update the DHCP configuration |
+
+
+## Freeplug
+
+**Class** : alphayax\freebox\api\v3\services\config\Freeplug
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getNetworks` | Get the freeplug networks information |
+| `getFromId` | Get a particular Freeplug information |
+| `resetFromId` | Reset a Freeplug |
diff --git a/docs/services/download/download.md b/docs/services/download/download.md
index 2d29299..13de2fb 100644
--- a/docs/services/download/download.md
+++ b/docs/services/download/download.md
@@ -5,11 +5,11 @@
# Overview
- [BlackList](download.md#BlackList)
-- [Configuration](download.md#Configuration)
-- [Download](download.md#Download)
-- [Feed](download.md#Feed)
-- [Peer](download.md#Peer)
- [Tracker](download.md#Tracker)
+- [Feed](download.md#Feed)
+- [Configuration](download.md#Configuration)
+- [Peer](download.md#Peer)
+- [Download](download.md#Download)
@@ -26,40 +26,19 @@
| `removeBlackListEntry` | Delete a particular blacklist entry |
| `addBlackListEntry` | Add a blacklist entry |
-
-## Configuration
+
+## Tracker
-**Class** : alphayax\freebox\api\v3\services\download\Configuration
+**Class** : alphayax\freebox\api\v3\services\download\Tracker
### Public methods
| Method | Description |
|---|---|
-| `getConfiguration` | Get the current Download configuration |
-| `setConfiguration` | Update the Download configuration |
-| `updateThrottlingMode` | You can force the throttling mode using this method. You can use any of the throttling modes defined in DlThrottlingConfig. |
-
-
-## Download
-
-**Class** : alphayax\freebox\api\v3\services\download\Download
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `getAll` | Returns the collection of all Download tasks |
-| `getFromId` | Returns the Download task with the given id |
-| `getLogFromId` | Get the current system info |
-| `deleteFromId` | Delete a download task (conserve data) |
-| `eraseFromId` | Delete a download task (erase data) |
-| `update` | Update a download task |
-| `addFromUrl` | Add a download task with the specified URL |
-| `addFromUrls` | Add a download task with all the specified URLs |
-| `addFromFile` | Add a download task with the specified file (torrent, nzb...) |
-| `getStats` | Returns the Download task with the given id |
-| `getFilesFromId` | Returns the downloaded files with the given task id |
-| `updateFilePriority` | Update a download priority |
+| `getAll` | Each torrent Download task has one or more DownloadTracker. Each tracker is identified by its announce URL. |
+| `add` | Add a new tracker Attempting to call this method on a download other than bittorent will fail |
+| `remove` | Remove a tracker Attempting to call this method on a download other than bittorent will fail |
+| `update` | Update a tracker Attempting to call this method on a download other than bittorent will fail |
## Feed
@@ -82,6 +61,19 @@
| `downloadFeedItem` | Download the specified feed item |
| `markFeedAsRead` | Mark the specified feed id as "Read" |
+
+## Configuration
+
+**Class** : alphayax\freebox\api\v3\services\download\Configuration
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getConfiguration` | Get the current Download configuration |
+| `setConfiguration` | Update the Download configuration |
+| `updateThrottlingMode` | You can force the throttling mode using this method. You can use any of the throttling modes defined in DlThrottlingConfig. |
+
## Peer
@@ -93,16 +85,24 @@
|---|---|
| `getAll` | Get the list of peers for a given Download Attempting to call this method on a download other than bittorent will fail |
-
-## Tracker
+
+## Download
-**Class** : alphayax\freebox\api\v3\services\download\Tracker
+**Class** : alphayax\freebox\api\v3\services\download\Download
### Public methods
| Method | Description |
|---|---|
-| `getAll` | Each torrent Download task has one or more DownloadTracker. Each tracker is identified by its announce URL. |
-| `add` | Add a new tracker Attempting to call this method on a download other than bittorent will fail |
-| `remove` | Remove a tracker Attempting to call this method on a download other than bittorent will fail |
-| `update` | Update a tracker Attempting to call this method on a download other than bittorent will fail |
+| `getAll` | Returns the collection of all Download tasks |
+| `getFromId` | Returns the Download task with the given id |
+| `getLogFromId` | Get the current system info |
+| `deleteFromId` | Delete a download task (conserve data) |
+| `eraseFromId` | Delete a download task (erase data) |
+| `update` | Update a download task |
+| `addFromUrl` | Add a download task with the specified URL |
+| `addFromUrls` | Add a download task with all the specified URLs |
+| `addFromFile` | Add a download task with the specified file (torrent, nzb...) |
+| `getStats` | Returns the Download task with the given id |
+| `getFilesFromId` | Returns the downloaded files with the given task id |
+| `updateFilePriority` | Update a download priority |
diff --git a/docs/services/login/login.md b/docs/services/login/login.md
index 78d19e5..2e3960d 100644
--- a/docs/services/login/login.md
+++ b/docs/services/login/login.md
@@ -4,24 +4,10 @@
# Overview
-- [Authorize](login.md#Authorize)
- [Session](login.md#Session)
+- [Authorize](login.md#Authorize)
-
-## Authorize
-
-**Class** : alphayax\freebox\api\v3\services\login\Authorize
-
-### Public methods
-
-| Method | Description |
-|---|---|
-| `ask_authorization` | Contact the freebox and ask for App auth |
-| `get_authorization_status` | |
-| `getStatus` | |
-| `getAppToken` | |
-
## Session
@@ -31,6 +17,21 @@
| Method | Description |
|---|---|
-| `ask_login_status` | |
-| `create_session` | |
+| `askLoginStatus` | |
+| `createSession` | |
| `getSessionToken` | |
+| `getPermissions` | |
+
+
+## Authorize
+
+**Class** : alphayax\freebox\api\v3\services\login\Authorize
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `askAuthorization` | Contact the freebox and ask for App auth |
+| `getAuthorizationStatus` | |
+| `getStatus` | |
+| `getAppToken` | |
diff --git a/docs/services/services.md b/docs/services/services.md
index e83869b..2c55405 100644
--- a/docs/services/services.md
+++ b/docs/services/services.md
@@ -4,86 +4,98 @@
# Overview
-- [AirMedia](./AirMedia/AirMedia.md)
- - [AirMediaReceiver](AirMedia/AirMedia.md#AirMediaReceiver)
- - [Config](AirMedia/AirMedia.md#Config)
-- [Call](./Call/Call.md)
- - [Contact](./Call/Contact/Contact.md)
- - [ContactAddress](Call/Contact/Contact.md#ContactAddress)
- - [ContactEmail](Call/Contact/Contact.md#ContactEmail)
- - [ContactEntry](Call/Contact/Contact.md#ContactEntry)
- - [ContactNumber](Call/Contact/Contact.md#ContactNumber)
- - [ContactUrl](Call/Contact/Contact.md#ContactUrl)
- - [CallEntry](Call/Call.md#CallEntry)
-- [FileSystem](./FileSystem/FileSystem.md)
- - [FileSharingLink](FileSystem/FileSystem.md#FileSharingLink)
- - [FileSystemListing](FileSystem/FileSystem.md#FileSystemListing)
- - [FileSystemOperation](FileSystem/FileSystem.md#FileSystemOperation)
- - [FileSystemTask](FileSystem/FileSystem.md#FileSystemTask)
- - [FileUpload](FileSystem/FileSystem.md#FileUpload)
-- [ParentalControl](./ParentalControl/ParentalControl.md)
- - [Filter](ParentalControl/ParentalControl.md#Filter)
- - [FilterPlanning](ParentalControl/ParentalControl.md#FilterPlanning)
-- [RRD](./RRD/RRD.md)
- - [Fetch](RRD/RRD.md#Fetch)
- [Storage](./Storage/Storage.md)
- - [Disk](Storage/Storage.md#Disk)
- - [Partition](Storage/Storage.md#Partition)
+ - [Disk](Storage/Storage.md#Disk)
+ - [Partition](Storage/Storage.md#Partition)
- [config](./config/config.md)
- - [Connection](./config/Connection/Connection.md)
- - [DynDns](./config/Connection/DynDns/DynDns.md)
- - [DynDns](config/Connection/DynDns/DynDns.md#DynDns)
- - [NoIP](config/Connection/DynDns/DynDns.md#NoIP)
- - [Ovh](config/Connection/DynDns/DynDns.md#Ovh)
- - [Connection](config/Connection/Connection.md#Connection)
- - [DynDns](config/Connection/Connection.md#DynDns)
- - [Ftth](config/Connection/Connection.md#Ftth)
- - [Xdsl](config/Connection/Connection.md#Xdsl)
- - [LAN](./config/LAN/LAN.md)
- - [Browser](config/LAN/LAN.md#Browser)
- - [LAN](config/LAN/LAN.md#LAN)
- - [NAT](./config/NAT/NAT.md)
- - [DMZ](config/NAT/NAT.md#DMZ)
- - [IncomingPort](config/NAT/NAT.md#IncomingPort)
- - [PortForwarding](config/NAT/NAT.md#PortForwarding)
- - [NetworkShare](./config/NetworkShare/NetworkShare.md)
- - [Afp](config/NetworkShare/NetworkShare.md#Afp)
- - [Samba](config/NetworkShare/NetworkShare.md#Samba)
- - [SwitchPort](./config/SwitchPort/SwitchPort.md)
- - [Config](config/SwitchPort/SwitchPort.md#Config)
- - [Stats](config/SwitchPort/SwitchPort.md#Stats)
- - [Status](config/SwitchPort/SwitchPort.md#Status)
- - [UPnP](./config/UPnP/UPnP.md)
- - [AV](config/UPnP/UPnP.md#AV)
- - [IGD](config/UPnP/UPnP.md#IGD)
- - [VPN](./config/VPN/VPN.md)
- - [Client](./config/VPN/Client/Client.md)
- - [Config](config/VPN/Client/Client.md#Config)
- - [Status](config/VPN/Client/Client.md#Status)
- - [Server](./config/VPN/Server/Server.md)
- - [Config](config/VPN/Server/Server.md#Config)
- - [Connection](config/VPN/Server/Server.md#Connection)
- - [IpPool](config/VPN/Server/Server.md#IpPool)
- - [User](config/VPN/Server/Server.md#User)
- - [WiFi](./config/WiFi/WiFi.md)
- - [AccessPoint](config/WiFi/WiFi.md#AccessPoint)
- - [Bss](config/WiFi/WiFi.md#Bss)
- - [Config](config/WiFi/WiFi.md#Config)
- - [MacFilter](config/WiFi/WiFi.md#MacFilter)
- - [Planning](config/WiFi/WiFi.md#Planning)
- - [DHCP](config/config.md#DHCP)
- - [FTP](config/config.md#FTP)
- - [Freeplug](config/config.md#Freeplug)
- - [LCD](config/config.md#LCD)
- - [System](config/config.md#System)
-- [download](./download/download.md)
- - [BlackList](download/download.md#BlackList)
- - [Configuration](download/download.md#Configuration)
- - [Download](download/download.md#Download)
- - [Feed](download/download.md#Feed)
- - [Peer](download/download.md#Peer)
- - [Tracker](download/download.md#Tracker)
+ - [LAN](./config/LAN/LAN.md)
+ - [LAN](config/LAN/LAN.md#LAN)
+ - [Browser](config/LAN/LAN.md#Browser)
+ - [SwitchPort](./config/SwitchPort/SwitchPort.md)
+ - [Status](config/SwitchPort/SwitchPort.md#Status)
+ - [Stats](config/SwitchPort/SwitchPort.md#Stats)
+ - [Config](config/SwitchPort/SwitchPort.md#Config)
+ - [VPN](./config/VPN/VPN.md)
+ - [Server](./config/VPN/Server/Server.md)
+ - [User](config/VPN/Server/Server.md#User)
+ - [IpPool](config/VPN/Server/Server.md#IpPool)
+ - [Connection](config/VPN/Server/Server.md#Connection)
+ - [Config](config/VPN/Server/Server.md#Config)
+ - [Client](./config/VPN/Client/Client.md)
+ - [Status](config/VPN/Client/Client.md#Status)
+ - [Config](config/VPN/Client/Client.md#Config)
+ - [UPnP](./config/UPnP/UPnP.md)
+ - [IGD](config/UPnP/UPnP.md#IGD)
+ - [AV](config/UPnP/UPnP.md#AV)
+ - [NetworkShare](./config/NetworkShare/NetworkShare.md)
+ - [Afp](config/NetworkShare/NetworkShare.md#Afp)
+ - [Samba](config/NetworkShare/NetworkShare.md#Samba)
+ - [WiFi](./config/WiFi/WiFi.md)
+ - [Planning](config/WiFi/WiFi.md#Planning)
+ - [MacFilter](config/WiFi/WiFi.md#MacFilter)
+ - [Config](config/WiFi/WiFi.md#Config)
+ - [Bss](config/WiFi/WiFi.md#Bss)
+ - [AccessPoint](config/WiFi/WiFi.md#AccessPoint)
+ - [Connection](./config/Connection/Connection.md)
+ - [DynDns](./config/Connection/DynDns/DynDns.md)
+ - [DynDns](config/Connection/DynDns/DynDns.md#DynDns)
+ - [NoIP](config/Connection/DynDns/DynDns.md#NoIP)
+ - [Ovh](config/Connection/DynDns/DynDns.md#Ovh)
+ - [DynDns](config/Connection/Connection.md#DynDns)
+ - [Ftth](config/Connection/Connection.md#Ftth)
+ - [Connection](config/Connection/Connection.md#Connection)
+ - [Xdsl](config/Connection/Connection.md#Xdsl)
+ - [NAT](./config/NAT/NAT.md)
+ - [PortForwarding](config/NAT/NAT.md#PortForwarding)
+ - [DMZ](config/NAT/NAT.md#DMZ)
+ - [IncomingPort](config/NAT/NAT.md#IncomingPort)
+ - [FTP](config/config.md#FTP)
+ - [System](config/config.md#System)
+ - [LCD](config/config.md#LCD)
+ - [DHCP](config/config.md#DHCP)
+ - [Freeplug](config/config.md#Freeplug)
+- [Call](./Call/Call.md)
+ - [Contact](./Call/Contact/Contact.md)
+ - [ContactNumber](Call/Contact/Contact.md#ContactNumber)
+ - [ContactAddress](Call/Contact/Contact.md#ContactAddress)
+ - [ContactUrl](Call/Contact/Contact.md#ContactUrl)
+ - [ContactEmail](Call/Contact/Contact.md#ContactEmail)
+ - [ContactEntry](Call/Contact/Contact.md#ContactEntry)
+ - [CallEntry](Call/Call.md#CallEntry)
+- [AirMedia](./AirMedia/AirMedia.md)
+ - [AirMediaReceiver](AirMedia/AirMedia.md#AirMediaReceiver)
+ - [Config](AirMedia/AirMedia.md#Config)
+- [ParentalControl](./ParentalControl/ParentalControl.md)
+ - [FilterPlanning](ParentalControl/ParentalControl.md#FilterPlanning)
+ - [Filter](ParentalControl/ParentalControl.md#Filter)
+- [RRD](./RRD/RRD.md)
+ - [Fetch](RRD/RRD.md#Fetch)
- [login](./login/login.md)
- - [Authorize](login/login.md#Authorize)
- - [Session](login/login.md#Session)
+ - [Session](login/login.md#Session)
+ - [Authorize](login/login.md#Authorize)
+- [FileSystem](./FileSystem/FileSystem.md)
+ - [FileSystemListing](FileSystem/FileSystem.md#FileSystemListing)
+ - [FileSharingLink](FileSystem/FileSystem.md#FileSharingLink)
+ - [FileSystemTask](FileSystem/FileSystem.md#FileSystemTask)
+ - [FileUpload](FileSystem/FileSystem.md#FileUpload)
+ - [FileSystemOperation](FileSystem/FileSystem.md#FileSystemOperation)
+- [download](./download/download.md)
+ - [BlackList](download/download.md#BlackList)
+ - [Tracker](download/download.md#Tracker)
+ - [Feed](download/download.md#Feed)
+ - [Configuration](download/download.md#Configuration)
+ - [Peer](download/download.md#Peer)
+ - [Download](download/download.md#Download)
+- [ApiVersion](services.md#ApiVersion)
+
+
+## ApiVersion
+
+**Class** : alphayax\freebox\api\v3\services\ApiVersion
+
+### Public methods
+
+| Method | Description |
+|---|---|
+| `getApiVersion` | Return a mapping of information about the api |