Tests documentation generation
This commit is contained in:
parent
173950b095
commit
008a3f38af
|
@ -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 |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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` | |
|
|
@ -0,0 +1,13 @@
|
||||||
|
|
||||||
|
# RRD
|
||||||
|
|
||||||
|
|
||||||
|
## Fetch
|
||||||
|
|
||||||
|
**Namespace** : alphayax\freebox\api\v3\services\RRD
|
||||||
|
|
||||||
|
### Public methods
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
|---|---|
|
||||||
|
| `getStats` | |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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` | |
|
|
@ -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` | |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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` | |
|
|
@ -0,0 +1,5 @@
|
||||||
|
|
||||||
|
# VPN
|
||||||
|
|
||||||
|
- [Client](./config/VPN/Client/Client.md)
|
||||||
|
- [Server](./config/VPN/Server/Server.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` | |
|
|
@ -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 |
|
|
@ -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 |
|
|
@ -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` | |
|
|
@ -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)
|
Loading…
Reference in New Issue