From 008a3f38afeab12d95da6d8849150e8f01b02214 Mon Sep 17 00:00:00 2001 From: alphayax Date: Sat, 11 Jun 2016 21:29:34 +0200 Subject: [PATCH] Tests documentation generation --- docs/AirMedia/AirMedia.md | 25 ++++++ docs/Call/Call.md | 18 +++++ docs/Call/Contact/Contact.md | 78 +++++++++++++++++++ docs/FileSystem/FileSystem.md | 84 ++++++++++++++++++++ docs/ParentalControl/ParentalControl.md | 31 ++++++++ docs/RRD/RRD.md | 13 ++++ docs/Storage/Storage.md | 30 ++++++++ docs/config/Connection/Connection.md | 50 ++++++++++++ docs/config/Connection/DynDns/DynDns.md | 39 ++++++++++ docs/config/LAN/LAN.md | 29 +++++++ docs/config/NAT/NAT.md | 41 ++++++++++ docs/config/NetworkShare/NetworkShare.md | 25 ++++++ docs/config/SwitchPort/SwitchPort.md | 34 ++++++++ docs/config/UPnP/UPnP.md | 27 +++++++ docs/config/VPN/Client/Client.md | 29 +++++++ docs/config/VPN/Server/Server.md | 51 ++++++++++++ docs/config/VPN/VPN.md | 5 ++ docs/config/WiFi/WiFi.md | 71 +++++++++++++++++ docs/config/config.md | 67 ++++++++++++++++ docs/download/download.md | 98 ++++++++++++++++++++++++ docs/login/login.md | 29 +++++++ docs/services.md | 12 +++ 22 files changed, 886 insertions(+) create mode 100644 docs/AirMedia/AirMedia.md create mode 100644 docs/Call/Call.md create mode 100644 docs/Call/Contact/Contact.md create mode 100644 docs/FileSystem/FileSystem.md create mode 100644 docs/ParentalControl/ParentalControl.md create mode 100644 docs/RRD/RRD.md create mode 100644 docs/Storage/Storage.md create mode 100644 docs/config/Connection/Connection.md create mode 100644 docs/config/Connection/DynDns/DynDns.md create mode 100644 docs/config/LAN/LAN.md create mode 100644 docs/config/NAT/NAT.md create mode 100644 docs/config/NetworkShare/NetworkShare.md create mode 100644 docs/config/SwitchPort/SwitchPort.md create mode 100644 docs/config/UPnP/UPnP.md create mode 100644 docs/config/VPN/Client/Client.md create mode 100644 docs/config/VPN/Server/Server.md create mode 100644 docs/config/VPN/VPN.md create mode 100644 docs/config/WiFi/WiFi.md create mode 100644 docs/config/config.md create mode 100644 docs/download/download.md create mode 100644 docs/login/login.md create mode 100644 docs/services.md diff --git a/docs/AirMedia/AirMedia.md b/docs/AirMedia/AirMedia.md new file mode 100644 index 0000000..8a7b2ec --- /dev/null +++ b/docs/AirMedia/AirMedia.md @@ -0,0 +1,25 @@ + +# AirMedia + + +## AirMediaReceiver + +**Namespace** : alphayax\freebox\api\v3\services\AirMedia + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of AirMediaReceiver connected to the Freebox Server | +| `sendRequest` | Sending a request to an AirMedia receiver | + +## Config + +**Namespace** : alphayax\freebox\api\v3\services\AirMedia + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current AirMedia configuration | +| `setConfiguration` | Update the AirMedia configuration | diff --git a/docs/Call/Call.md b/docs/Call/Call.md new file mode 100644 index 0000000..ff6fc06 --- /dev/null +++ b/docs/Call/Call.md @@ -0,0 +1,18 @@ + +# Call + +- [Contact](./Call/Contact/Contact.md) + +## CallEntry + +**Namespace** : alphayax\freebox\api\v3\services\Call + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | List every calls | +| `getFromId` | Access a given call entry | +| `delete` | Delete a call entry | +| `deleteFromId` | Delete a call entry | +| `update` | Update a given call entry | diff --git a/docs/Call/Contact/Contact.md b/docs/Call/Contact/Contact.md new file mode 100644 index 0000000..55406cd --- /dev/null +++ b/docs/Call/Contact/Contact.md @@ -0,0 +1,78 @@ + +# Contact + + +## ContactAddress + +**Namespace** : alphayax\freebox\api\v3\services\Call\Contact + +### Public methods + +| Method | Description | +|---|---| +| `getFromId` | Get the address (with the given id) | +| `create` | Add an address | +| `delete` | Remove an address | +| `deleteFromId` | Remove an address (with the given id) | +| `update` | Update an address | + +## ContactEmail + +**Namespace** : alphayax\freebox\api\v3\services\Call\Contact + +### Public methods + +| Method | Description | +|---|---| +| `getFromId` | Get the email contact (with the given id) | +| `create` | Create a new email contact | +| `delete` | Remove an email contact | +| `deleteFromId` | Remove an email contact (with the given id) | +| `update` | Update an email contact | + +## ContactEntry + +**Namespace** : alphayax\freebox\api\v3\services\Call\Contact + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | List all contacts | +| `getFromId` | Get a specific contact entry | +| `create` | Add a contact entry | +| `update` | Update a contact entry | +| `delete` | Remove a contact entry | +| `deleteFromId` | remove a contact entry (with the specified id) | +| `getContactNumbersFromContactId` | Get all numbers associated to a given contact id | +| `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 + +**Namespace** : alphayax\freebox\api\v3\services\Call\Contact + +### 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 + +**Namespace** : alphayax\freebox\api\v3\services\Call\Contact + +### 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/FileSystem/FileSystem.md b/docs/FileSystem/FileSystem.md new file mode 100644 index 0000000..4f9487c --- /dev/null +++ b/docs/FileSystem/FileSystem.md @@ -0,0 +1,84 @@ + +# FileSystem + + +## FileSharingLink + +**Namespace** : alphayax\freebox\api\v3\services\FileSystem + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Retrieve a File Sharing link | +| `getFromToken` | | +| `deleteFromToken` | Delete a File Sharing link +Deletes the ShareLink task with the given token, if the task was running, stop it. | +| `create` | Create a File Sharing link | + +## FileSystemListing + +**Namespace** : alphayax\freebox\api\v3\services\FileSystem + +### Public methods + +| Method | Description | +|---|---| +| `getFilesFromDirectory` | | +| `getFileInformation` | Get file information | + +## FileSystemOperation + +**Namespace** : alphayax\freebox\api\v3\services\FileSystem + +### 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 | + +## FileSystemTask + +**Namespace** : alphayax\freebox\api\v3\services\FileSystem + +### Public methods + +| Method | Description | +|---|---| +| `getAllTasks` | | +| `getTaskById` | | +| `deleteTask` | | +| `deleteTaskById` | | +| `updateTask` | | + +## FileUpload + +**Namespace** : alphayax\freebox\api\v3\services\FileSystem + +### Public methods + +| Method | Description | +|---|---| +| `createAuthorization` | Create a file upload authorization | +| `uploadFile` | Send the content of the FileUpload task | +| `getAll` | Get the list of uploads | +| `getFromId` | Track an upload status | +| `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 | diff --git a/docs/ParentalControl/ParentalControl.md b/docs/ParentalControl/ParentalControl.md new file mode 100644 index 0000000..0a10033 --- /dev/null +++ b/docs/ParentalControl/ParentalControl.md @@ -0,0 +1,31 @@ + +# ParentalControl + + +## Filter + +**Namespace** : alphayax\freebox\api\v3\services\ParentalControl + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | | +| `setConfiguration` | | +| `getAll` | Get the list of disks | +| `getFromId` | | +| `update` | | +| `delete` | | +| `deleteFromId` | | +| `add` | | + +## FilterPlanning + +**Namespace** : alphayax\freebox\api\v3\services\ParentalControl + +### Public methods + +| Method | Description | +|---|---| +| `getFromFilterId` | | +| `setFromFilterId` | | diff --git a/docs/RRD/RRD.md b/docs/RRD/RRD.md new file mode 100644 index 0000000..abae177 --- /dev/null +++ b/docs/RRD/RRD.md @@ -0,0 +1,13 @@ + +# RRD + + +## Fetch + +**Namespace** : alphayax\freebox\api\v3\services\RRD + +### Public methods + +| Method | Description | +|---|---| +| `getStats` | | diff --git a/docs/Storage/Storage.md b/docs/Storage/Storage.md new file mode 100644 index 0000000..7d1ae82 --- /dev/null +++ b/docs/Storage/Storage.md @@ -0,0 +1,30 @@ + +# Storage + + +## Disk + +**Namespace** : alphayax\freebox\api\v3\services\Storage + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of disks | +| `getFromId` | Get a given disk info | +| `update` | Update a disk state | +| `format` | Format the disk with the given id +There will be one partition using all the available space on disk. All previous data will be lost. | + +## Partition + +**Namespace** : alphayax\freebox\api\v3\services\Storage + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of partitions | +| `getFromId` | Get a given partition info | +| `check` | Checks the partition with the given id +*NOTE* once started you can monitor the fsck process getting the partition information | diff --git a/docs/config/Connection/Connection.md b/docs/config/Connection/Connection.md new file mode 100644 index 0000000..be4b4c7 --- /dev/null +++ b/docs/config/Connection/Connection.md @@ -0,0 +1,50 @@ + +# Connection + +- [DynDns](./config/Connection/DynDns/DynDns.md) + +## Connection + +**Namespace** : alphayax\freebox\api\v3\services\config\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 + +**Namespace** : alphayax\freebox\api\v3\services\config\Connection + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | Get the current DDns status | +| `getConfig` | Get the current DDns Configuration | +| `setConfig` | Set the DDns Configuration | + +## Ftth + +**Namespace** : alphayax\freebox\api\v3\services\config\Connection + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | Get the current Connection status | + +## Xdsl + +**Namespace** : alphayax\freebox\api\v3\services\config\Connection + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | Get the current Connection status | diff --git a/docs/config/Connection/DynDns/DynDns.md b/docs/config/Connection/DynDns/DynDns.md new file mode 100644 index 0000000..757a501 --- /dev/null +++ b/docs/config/Connection/DynDns/DynDns.md @@ -0,0 +1,39 @@ + +# DynDns + + +## DynDns + +**Namespace** : alphayax\freebox\api\v3\services\config\Connection\DynDns + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | | +| `getConfig` | | +| `setConfig` | | + +## NoIP + +**Namespace** : alphayax\freebox\api\v3\services\config\Connection\DynDns + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | | +| `getConfig` | | +| `setConfig` | | + +## Ovh + +**Namespace** : alphayax\freebox\api\v3\services\config\Connection\DynDns + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | | +| `getConfig` | | +| `setConfig` | | diff --git a/docs/config/LAN/LAN.md b/docs/config/LAN/LAN.md new file mode 100644 index 0000000..063d1f2 --- /dev/null +++ b/docs/config/LAN/LAN.md @@ -0,0 +1,29 @@ + +# LAN + + +## Browser + +**Namespace** : alphayax\freebox\api\v3\services\config\LAN + +### Public methods + +| Method | Description | +|---|---| +| `getBrowsableInterfaces` | | +| `getHostsFromInterface` | | +| `getHostsFromInterfaceName` | | +| `getHostFromId` | | +| `updateHostFromInterfaceId` | | +| `wakeOnLan` | Send Wake ok Lan packet to an host | + +## LAN + +**Namespace** : alphayax\freebox\api\v3\services\config\LAN + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | | +| `setConfiguration` | | diff --git a/docs/config/NAT/NAT.md b/docs/config/NAT/NAT.md new file mode 100644 index 0000000..76346c0 --- /dev/null +++ b/docs/config/NAT/NAT.md @@ -0,0 +1,41 @@ + +# NAT + + +## DMZ + +**Namespace** : alphayax\freebox\api\v3\services\config\NAT + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current Dmz configuration | +| `setConfiguration` | Update the current Dmz configuration | + +## IncomingPort + +**Namespace** : alphayax\freebox\api\v3\services\config\NAT + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Getting the list of incoming ports | +| `getById` | Getting a specific incoming port | +| `update` | Updating an incoming port | + +## PortForwarding + +**Namespace** : alphayax\freebox\api\v3\services\config\NAT + +### 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 | diff --git a/docs/config/NetworkShare/NetworkShare.md b/docs/config/NetworkShare/NetworkShare.md new file mode 100644 index 0000000..a6a22dc --- /dev/null +++ b/docs/config/NetworkShare/NetworkShare.md @@ -0,0 +1,25 @@ + +# NetworkShare + + +## Afp + +**Namespace** : alphayax\freebox\api\v3\services\config\NetworkShare + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current Afp configuration | +| `setConfiguration` | Update the Afp configuration | + +## Samba + +**Namespace** : alphayax\freebox\api\v3\services\config\NetworkShare + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current Samba configuration | +| `setConfiguration` | Update the Samba configuration | diff --git a/docs/config/SwitchPort/SwitchPort.md b/docs/config/SwitchPort/SwitchPort.md new file mode 100644 index 0000000..1b11848 --- /dev/null +++ b/docs/config/SwitchPort/SwitchPort.md @@ -0,0 +1,34 @@ + +# SwitchPort + + +## Config + +**Namespace** : alphayax\freebox\api\v3\services\config\SwitchPort + +### Public methods + +| Method | Description | +|---|---| +| `getFromPortId` | Get a port configuration | +| `update` | Update a port configuration | + +## Stats + +**Namespace** : alphayax\freebox\api\v3\services\config\SwitchPort + +### Public methods + +| Method | Description | +|---|---| +| `getFromPortId` | Get a port configuration | + +## Status + +**Namespace** : alphayax\freebox\api\v3\services\config\SwitchPort + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | Get the current switch status | diff --git a/docs/config/UPnP/UPnP.md b/docs/config/UPnP/UPnP.md new file mode 100644 index 0000000..f2d87cb --- /dev/null +++ b/docs/config/UPnP/UPnP.md @@ -0,0 +1,27 @@ + +# UPnP + + +## AV + +**Namespace** : alphayax\freebox\api\v3\services\config\UPnP + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current UPnP AV configuration | +| `setConfiguration` | Update the UPnP AV configuration | + +## IGD + +**Namespace** : alphayax\freebox\api\v3\services\config\UPnP + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current UPnP AV configuration | +| `setConfiguration` | Update the UPnP AV configuration | +| `getRedirections` | Get the list of current redirection | +| `deleteRedirectionFromId` | Delete a redirection | diff --git a/docs/config/VPN/Client/Client.md b/docs/config/VPN/Client/Client.md new file mode 100644 index 0000000..483c946 --- /dev/null +++ b/docs/config/VPN/Client/Client.md @@ -0,0 +1,29 @@ + +# Client + + +## Config + +**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Client + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get VPN Client configuration list | +| `getFromId` | | +| `add` | | +| `delete` | | +| `deleteFromId` | | +| `update` | | + +## Status + +**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Client + +### Public methods + +| Method | Description | +|---|---| +| `getStatus` | Get the VPN client status | +| `getLogs` | Get the VPN client Logs | diff --git a/docs/config/VPN/Server/Server.md b/docs/config/VPN/Server/Server.md new file mode 100644 index 0000000..b6213b9 --- /dev/null +++ b/docs/config/VPN/Server/Server.md @@ -0,0 +1,51 @@ + +# Server + + +## Config + +**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server + +### Public methods + +| Method | Description | +|---|---| +| `getConfigurationFromId` | Get a VPN config | +| `setConfiguration` | Update the VPN configuration | + +## Connection + +**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of connections | +| `closeFromId` | Close a given connection | + +## IpPool + +**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server + +### Public methods + +| Method | Description | +|---|---| +| `getReservations` | Get the VPN server IP pool reservations | + +## User + +**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of VPNUser | +| `getFromLogin` | Gets the VPNUser with the given login | +| `add` | Creates a new VPNUser | +| `delete` | Deletes the VPNUser | +| `deleteFromLogin` | Deletes the VPNUser | +| `update` | Update a VPN Use | +| `getConfigurationFile` | | diff --git a/docs/config/VPN/VPN.md b/docs/config/VPN/VPN.md new file mode 100644 index 0000000..ed66772 --- /dev/null +++ b/docs/config/VPN/VPN.md @@ -0,0 +1,5 @@ + +# VPN + +- [Client](./config/VPN/Client/Client.md) +- [Server](./config/VPN/Server/Server.md) diff --git a/docs/config/WiFi/WiFi.md b/docs/config/WiFi/WiFi.md new file mode 100644 index 0000000..ee99ee8 --- /dev/null +++ b/docs/config/WiFi/WiFi.md @@ -0,0 +1,71 @@ + +# WiFi + + +## AccessPoint + +**Namespace** : alphayax\freebox\api\v3\services\config\WiFi + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | | +| `getFromId` | | +| `getAllowedCombFromId` | To be able to allow user to pick a valid channel combination for a given AP you should use the following api to retrieve the list of allowed channel combination. | +| `getStationsFromId` | To be able to allow user to pick a valid channel combination for a given AP you should use the following api to retrieve the list of allowed channel combination. | +| `update` | | +| `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 + +**Namespace** : alphayax\freebox\api\v3\services\config\WiFi + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of Freebox Access Points | +| `getFromId` | Get the list of Freebox Access Points | +| `update` | Get the list of Freebox Access Points | + +## Config + +**Namespace** : alphayax\freebox\api\v3\services\config\WiFi + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | | +| `setConfiguration` | | +| `resetConfiguration` | Reset Wifi to default configuration | + +## MacFilter + +**Namespace** : alphayax\freebox\api\v3\services\config\WiFi + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | | +| `getFromId` | | +| `update` | | +| `delete` | | +| `deleteFromId` | | +| `add` | | + +## Planning + +**Namespace** : alphayax\freebox\api\v3\services\config\WiFi + +### Public methods + +| Method | Description | +|---|---| +| `getPlanning` | | +| `update` | | diff --git a/docs/config/config.md b/docs/config/config.md new file mode 100644 index 0000000..b6f2e7e --- /dev/null +++ b/docs/config/config.md @@ -0,0 +1,67 @@ + +# config + +- [Connection](./config/Connection/Connection.md) +- [LAN](./config/LAN/LAN.md) +- [NAT](./config/NAT/NAT.md) +- [NetworkShare](./config/NetworkShare/NetworkShare.md) +- [SwitchPort](./config/SwitchPort/SwitchPort.md) +- [UPnP](./config/UPnP/UPnP.md) +- [VPN](./config/VPN/VPN.md) +- [WiFi](./config/WiFi/WiFi.md) + +## DHCP + +**Namespace** : alphayax\freebox\api\v3\services\config + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | | +| `setConfiguration` | | + +## FTP + +**Namespace** : alphayax\freebox\api\v3\services\config + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | | +| `setConfiguration` | | + +## Freeplug + +**Namespace** : alphayax\freebox\api\v3\services\config + +### Public methods + +| Method | Description | +|---|---| +| `getNetworks` | Get the current system info | +| `getFromId` | Get a particular Freeplug information | +| `resetFromId` | Reset a Freeplug | + +## LCD + +**Namespace** : alphayax\freebox\api\v3\services\config + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | | +| `setConfiguration` | | + +## System + +**Namespace** : alphayax\freebox\api\v3\services\config + +### Public methods + +| Method | Description | +|---|---| +| `getConfiguration` | Get the current system info | +| `reboot` | Reboot the Freebox | diff --git a/docs/download/download.md b/docs/download/download.md new file mode 100644 index 0000000..3a2f3c8 --- /dev/null +++ b/docs/download/download.md @@ -0,0 +1,98 @@ + +# download + + +## BlackList + +**Namespace** : alphayax\freebox\api\v3\services\download + +### Public methods + +| Method | Description | +|---|---| +| `getAllFromDownloadTaskId` | Get the list of blacklist entries for a given download +Attempting to call this method on a download other than bittorent will fail. | +| `emptyBlackListFromDownloadId` | Empty the blacklist for a given download +This call allow to remove all global entries, and entries related to the given download | +| `removeBlackListEntry` | Delete a particular blacklist entry | +| `addBlackListEntry` | Add a blacklist entry | + +## Configuration + +**Namespace** : alphayax\freebox\api\v3\services\download + +### 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 + +**Namespace** : alphayax\freebox\api\v3\services\download + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Returns the collection of all Download tasks | +| `getFromId` | Returns the Download task with the given id | +| `update` | Update a download task | +| `addFromUrl` | | +| `addFromUrls` | | +| `addFromFile` | | +| `getStats` | Returns the Download task with the given id | +| `getFilesFromId` | Returns the Download task with the given id | + +## Feed + +**Namespace** : alphayax\freebox\api\v3\services\download + +### Public methods + +| Method | Description | +|---|---| +| `getAllFeeds` | Get the list of all download Feeds | +| `getFeedFromId` | Gets the DownloadFeed with the given id | +| `addFeed` | Add a Download Feed | +| `removeFeed` | Delete a Download Feed | +| `updateFeed` | Update a Download Feed | +| `refreshFeed` | Remotely fetches the RSS feed and updates it. +Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error | +| `refreshFeeds` | Remotely fetches the RSS feed and updates it. +Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error | +| `getFeedItems` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | +| `updateFeedItem` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | +| `downloadFeedItem` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | +| `markFeedAsRead` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | + +## Peer + +**Namespace** : alphayax\freebox\api\v3\services\download + +### Public methods + +| Method | Description | +|---|---| +| `getAll` | Get the list of peers for a given Download +Attempting to call this method on a download other than bittorent will fail | + +## Tracker + +**Namespace** : alphayax\freebox\api\v3\services\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 | diff --git a/docs/login/login.md b/docs/login/login.md new file mode 100644 index 0000000..081c73d --- /dev/null +++ b/docs/login/login.md @@ -0,0 +1,29 @@ + +# login + + +## Authorize + +**Namespace** : alphayax\freebox\api\v3\services\login + +### Public methods + +| Method | Description | +|---|---| +| `__construct` | Authorize constructor. | +| `ask_authorization` | Contact the freebox and ask for App auth | +| `get_authorization_status` | | +| `getStatus` | | +| `getAppToken` | | + +## Session + +**Namespace** : alphayax\freebox\api\v3\services\login + +### Public methods + +| Method | Description | +|---|---| +| `ask_login_status` | | +| `create_session` | | +| `getSessionToken` | | diff --git a/docs/services.md b/docs/services.md new file mode 100644 index 0000000..f623c13 --- /dev/null +++ b/docs/services.md @@ -0,0 +1,12 @@ + +# services + +- [FileSystem](./FileSystem/FileSystem.md) +- [ParentalControl](./ParentalControl/ParentalControl.md) +- [RRD](./RRD/RRD.md) +- [Storage](./Storage/Storage.md) +- [AirMedia](./AirMedia/AirMedia.md) +- [Call](./Call/Call.md) +- [config](./config/config.md) +- [download](./download/download.md) +- [login](./login/login.md)