README.md in freebox_api-0.2.2 vs README.md in freebox_api-0.2.3

- old
+ new

@@ -400,284 +400,20 @@ ```ruby FreeboxApi::Configuration::Dhcp.dynamic_leases(mySession) ``` +#### FTP -OLD API -======= +##### Get the current FTP configuration - -### Ftp - -#### Ftp config API - -##### Get the current Ftp configuration -[X] GET /api/v1/ftp/config/ - ```ruby -config.show('ftp') +FreeboxApi::Configuration::Ftp.getConfig(mySession) ``` -##### Update the FTP configuration -[X] PUT /api/v1/ftp/config/ +##### Update the current FTP configuration ```ruby -config.update('ftp', { - :enabled => true -}) -``` - -### NAT - -#### Dmz Config API - -##### Get the current Dmz configuration -[X] GET /api/v1/fw/dmz/ - -```ruby -config.show('dmz') -``` - -##### Update the current Dmz configuration -[X] PUT /api/v1/fw/dmz/ - -```ruby -config.update('dmz', { +FreeboxApi::Configuration::Ftp.updateConfig(mySession, { :enabled => true, - :ip => '192.168.1.42', }) ``` - -### Port Forwarding - -#### Port Forwarding API - -##### Getting the list of port forwarding -[X] GET /api/v1/fw/redir/ - -```ruby -port_forwardings = FreeboxApi::Resources::PortForwarding.new(mySession) -port_forwardings.index -``` - -##### Getting a specific port forwarding -[X] GET /api/v1/fw/redir/{redir\_id} - -```ruby -port_forwardings.show(1) -``` - -##### Updating a port forwarding -[X] PUT /api/v1/fw/redir/{redir\_id} - -```ruby -port_forwardings.update({ - :id => 1, - :enabled => false, -}) -``` - -##### Add a port forwarding -[X] POST /api/v1/fw/redir/ - -```ruby -port_forwardings.create({ - :enabled => true, - :comment => 'test', - :lan_port => 4242, - :wan_port_end => 4242, - :wan_port_start => 4242, - :lan_ip => '192.168.1.42', - :ip_proto => 'tcp', -}) -``` - -##### Delete a port forwarding -[X] DELETE /api/v1/fw/redir/{redir\_id} - -```ruby -port_forwardings.destroy(3) -``` - -### UPnP IGD - -#### UPnP IGD config API - -##### Get the current UPnP IGD configuration -[X] GET /api/v1/upnpigd/config/ - -```ruby -config.show('upnpigd') -``` - -##### Update the UPnP IGD configuration -[X] PUT /api/v1/upnpigd/config/ - -```ruby -config.update('upnpigd', { - :enabled => true, -}) -``` - -#### UPnP IGD Redirection API - -##### Get the list of current redirection -[X] GET /api/v1/upnpigd/redir/ - -```ruby -upnp_redir = FreeboxApi::Resources::UPnPRedir.new(mySession) -upnp_redir.index -``` - -##### Delete a redirection -[X] DELETE /api/v1/upnpigd/redir/{id} - -```ruby -upnp_redir.destroy('0.0.0.0-53644-udp') -``` - -### LCD - -#### LCD config API - -##### Get the current LCD configuration -[X] GET /api/v1/lcd/config/ - -```ruby -config.show('lcd') -``` - -##### Update the lcd configuration -[X] PUT /api/v1/lcd/config/ - -```ruby -config.update('lcd', { - :brightness => 50, -}) -``` - -### Network Share - -#### Samba config API - -##### Get the current Samba configuration -[X] GET /api/v1/netshare/samba/ - -```ruby -config.show('samba') -``` - -##### Update the Samba configuration -[X] PUT /api/v1/netshare/samba/ - -```ruby -config.update('samba', { - :print_share_enabled => false, -}) -``` - -#### Afp config API - -##### Get the current Afp configuration -[X] GET /api/v1/netshare/afp/ - -```ruby -config.show('afp') -``` - -##### Update the Afp configuration -[X] PUT /api/v1/netshare/afp/ - -```ruby -config.update('afp', { - :guest_allow => false, -}) -``` - -### UPnP AV - -#### UPnP AV config API - -##### Get the current UPnP AV configuration -[X] GET /api/v1/upnpav/config/ - -```ruby -config.show('upnpav') -``` - -##### Update the UPnP AV configuration -[X] PUT /api/v1/upnpav/config/ - -```ruby -config.update('upnpav', { - :enabled => false, -}) -``` - -### Switch - -#### Switch API - -##### Get the current switch status -[ ] GET /api/v1/switch/status/ - -##### Get a port configuration -[ ] GET /api/v1/switch/port/{id} - -##### Update a port configuration -[ ] PUT /api/v1/switch/port/{id} - -##### Get a port stats -[ ] GET /api/v1/switch/port/{id}/stats - -### Wi-Fi - -#### Wi-Fi Status API - -##### Get the current Wi-Fi status -[ ] GET /api/v1/wifi/ - -#### Wi-Fi config API - -##### Get the current Wi-Fi configuration -[X] GET /api/v1/wifi/config/ - -```ruby -config.show('wifi') -``` - -##### Update the Wi-Fi configuration -[X] PUT /api/v1/wifi/config/ - -```ruby -config.update('wifi', { - :ap_params => { - :ht_mode => 'disabled', - } -}) -``` - -##### Reset the Wi-Fi configuration -[ ] POST /api/v1/wifi/config/reset/ - -#### Wi-Fi Stations API - -##### Get Wi-Fi Stations List -[ ] GET /api/v1/wifi/stations/{bss\_name}/ - -#### Wi-Fi MAC Filter API - -##### Get the MAC filter list -[ ] GET /api/v1/wifi/mac\_filter/ - -##### Getting a particular MAC filter -[ ] GET /api/v1/wifi/mac\_filter/{filter\_id} - -##### Updating a MAC filter -[ ] PUT /api/v1/wifi/mac\_filter/{filter\_id} - -##### Delete a MAC filter -[ ] DELETE /api/v1/wifi/mac\_filter/{filter\_id} - -##### Create a new MAC filter -[ ] POST /api/v1/wifi/mac\_filter/