net.minidev.ovh.api

Class ApiOvhFreefax

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhFreefax

public class ApiOvhFreefax
extends ApiOvhBase

BasePath:https://eu.api.ovh.com/1.0 ResourcePath:/freefax version:1.0

Field Summary

Fields inherited from class net.minidev.ovh.core.ApiOvhBase

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhFreefax(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
OvhBalanceInformations	credits_GET() Get the credit balance and the remaining pages available for all our freefax REST: GET /freefax/credits
ArrayList<String>	GET() List available services REST: GET /freefax
String	serviceName_changePassword_POST(String serviceName) Generates a new password for your fax account REST: POST /freefax/{serviceName}/changePassword
OvhFreefaxProperties	serviceName_GET(String serviceName) Get this object properties REST: GET /freefax/{serviceName}
String	serviceName_mainService_GET(String serviceName) Main service attached to freefax REST: GET /freefax/{serviceName}/mainService
void	serviceName_PUT(String serviceName, OvhFreefaxProperties body) Alter this object properties REST: PUT /freefax/{serviceName}
OvhService	serviceName_serviceInfos_GET(String serviceName) Get this object properties REST: GET /freefax/{serviceName}/serviceInfos
void	serviceName_serviceInfos_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /freefax/{serviceName}/serviceInfos
void	serviceName_voicemail_changePassword_POST(String serviceName, String password) Change the voicemail password.
void	serviceName_voicemail_changeRouting_POST(String serviceName, OvhVoicefaxRoutingEnum routing) Disable/Enable voicemail.
OvhVoicemailProperties	serviceName_voicemail_GET(String serviceName) Get this object properties REST: GET /freefax/{serviceName}/voicemail
void	serviceName_voicemail_PUT(String serviceName, OvhVoicemailProperties body) Alter this object properties REST: PUT /freefax/{serviceName}/voicemail
OvhVoicefaxRoutingEnum	serviceName_voicemail_routing_GET(String serviceName) Get the status of the voicemail.
OvhVoicemailNumbers	serviceName_voicemail_voicemailNumbers_GET(String serviceName) Get number for internal and external voicemail REST: GET /freefax/{serviceName}/voicemail/voicemailNumbers

Methods inherited from class net.minidev.ovh.core.ApiOvhBase

addBody, convertTo, convertTo, exec, execN, getCore, getNic, path, query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiOvhFreefax

public ApiOvhFreefax(ApiOvhCore core)

Method Detail

serviceName_serviceInfos_GET

public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException

Get this object properties REST: GET /freefax/{serviceName}/serviceInfos

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

serviceName_serviceInfos_PUT

public void serviceName_serviceInfos_PUT(String serviceName,
                                         OvhService body)
                                  throws IOException

Alter this object properties REST: PUT /freefax/{serviceName}/serviceInfos

Parameters:

body - [required] New object properties

serviceName - [required] Freefax number

Throws:

IOException

serviceName_GET

public OvhFreefaxProperties serviceName_GET(String serviceName)
                                     throws IOException

Get this object properties REST: GET /freefax/{serviceName}

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

serviceName_PUT

public void serviceName_PUT(String serviceName,
                            OvhFreefaxProperties body)
                     throws IOException

Alter this object properties REST: PUT /freefax/{serviceName}

Parameters:

body - [required] New object properties

serviceName - [required] Freefax number

Throws:

IOException

serviceName_voicemail_GET

public OvhVoicemailProperties serviceName_voicemail_GET(String serviceName)
                                                 throws IOException

Get this object properties REST: GET /freefax/{serviceName}/voicemail

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

serviceName_voicemail_PUT

public void serviceName_voicemail_PUT(String serviceName,
                                      OvhVoicemailProperties body)
                               throws IOException

Alter this object properties REST: PUT /freefax/{serviceName}/voicemail

Parameters:

body - [required] New object properties

serviceName - [required] Freefax number

Throws:

IOException

serviceName_voicemail_changeRouting_POST

public void serviceName_voicemail_changeRouting_POST(String serviceName,
                                                     OvhVoicefaxRoutingEnum routing)
                                              throws IOException

Disable/Enable voicemail. Available only if the line has fax capabilities REST: POST /freefax/{serviceName}/voicemail/changeRouting

Parameters:

routing - [required] Activate or Desactivate voicemail on the line

serviceName - [required] Freefax number

Throws:

IOException

serviceName_voicemail_voicemailNumbers_GET

public OvhVoicemailNumbers serviceName_voicemail_voicemailNumbers_GET(String serviceName)
                                                               throws IOException

Get number for internal and external voicemail REST: GET /freefax/{serviceName}/voicemail/voicemailNumbers

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

serviceName_voicemail_changePassword_POST

public void serviceName_voicemail_changePassword_POST(String serviceName,
                                                      String password)
                                               throws IOException

Change the voicemail password. It must be 4 digit REST: POST /freefax/{serviceName}/voicemail/changePassword

Parameters:

password - [required] The password

serviceName - [required] Freefax number

Throws:

IOException

serviceName_voicemail_routing_GET

public OvhVoicefaxRoutingEnum serviceName_voicemail_routing_GET(String serviceName)
                                                         throws IOException

Get the status of the voicemail. Available only if the line has fax capabilities REST: GET /freefax/{serviceName}/voicemail/routing

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

serviceName_changePassword_POST

public String serviceName_changePassword_POST(String serviceName)
                                       throws IOException

Generates a new password for your fax account REST: POST /freefax/{serviceName}/changePassword

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

serviceName_mainService_GET

public String serviceName_mainService_GET(String serviceName)
                                   throws IOException

Main service attached to freefax REST: GET /freefax/{serviceName}/mainService

Parameters:

serviceName - [required] Freefax number

Throws:

IOException

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /freefax

Throws:

IOException

credits_GET

public OvhBalanceInformations credits_GET()
                                   throws IOException

Get the credit balance and the remaining pages available for all our freefax REST: GET /freefax/credits

Throws:

IOException