RRPproxy (RRPproxy.net API v0.1.7) View Source
Documentation for RRPproxy
which provides API for rrpproxy.net.
Installation
This package can be installed by adding rrpproxy
to your list of dependencies in mix.exs
:
def deps do
[
{:rrpproxy, "~> 0.1.7"}
]
end
Configuration
Put the following lines into your config.exs
or better, into your environment
configuration files like test.exs
, dev.exs
or prod.exs
.
config :rrpproxy,
username: "<your login>",
password: "<your password>",
ote: true
Usage Examples
Check for a free domain, where false
means "not available" and true
means "available":
iex> RRPproxy.status_domain("example.com")
{:ok, false}
Link to this section Summary
Functions
activate_appendix activates an appendix.
add_contact adds a new contact and returns a contact handle.
add_domain registers a new domain.
add_nameserver adds a nameservers to be used for nameserverging domains or zones.
add_tag adds a tags to be used for tagging domains or zones.
check_domain checks wether the given domain name is free.
check_nameserver checks a the given nameserver.
clone_contact clones the given contact.
convert_currency converts the currency according to their current rates.
delete_contact deletes a given contact.
delete_domain deletes a registered domain.
delete_event deletes the given event by id.
delete_nameserver deletes a the given nameserver.
delete_tag deletes a the given tag.
get_zone returns the correct zone for the given domainname.
get_zone_info returns zone information for the given zone.
modify_contact modifies an existing contact and returns a contact handle.
modify_domain modifies domains by the given domain name for domains and zones.
modify_nameserver modifies nameservers by the given nameserver name for domains and zones.
modify_registrar modifies the registrar's (or subaccounts) settings.
modify_tag modifies tags by the given tag name for domains and zones.
query_accounting_list returns all items for accounting since the given date.
query_appendix_list returns a list of all appendices.
query_available_promotion_list returns all available promotions.
query_contact_list returns a list of all contact handles.
query_domain_list returns a list of all registerd domains.
query_event_list returns a list of events since the given date.
query_foreign_transfer_list returns a list of foreign transfers.
query_nameserver_list gets a list of nameservers.
query_tag_list gets a list of tags.
query_transfer_list returns a list of local transfers.
query_upcoming_accounting_list returns all items that are upcoming for accounting.
query_zone_list returns the prices per zone.
renew_domain renews a registered domain.
request_token requests a verification token for the given contact or domain.
restore_contact restores a deleted contact.
restore_domain restores a registered domain.
set_auth_code sets the domains auth-code for transfer.
set_domain_renewal_mode sets the domains renewal-mode.
set_domain_transfer_mode sets the domains transfer-mode.
status_account returns information about the accounts financial status.
get_contact returns a contact handle.
status_domain gets the given domain by name.
status_domain_transfer command informs you about the current status of a transfer. You can check if the transfer was successfully initiated or who received the eMail to confirm a transfer.
status_event gets an event by id.
status_nameserver gets the given nameserver by name.
status_owner_change explicity checks the status of an OwnerChange in detail.
status_registrar returns information about your account information.
status_tag gets the given tag by name.
transfer_domain transfers a foreign domain into our account.
Link to this section Types
Specs
boolean_opt() :: boolean() | nil
Specs
client_opt() :: RRPproxy.Client.t() | nil
Specs
integer_opt() :: integer() | nil
Specs
Specs
string_opt() :: String.t() | nil
Link to this section Functions
activate_appendix(appendix, accept_terms_and_conditions \\ true, client \\ Client.new())
View SourceSpecs
activate_appendix(String.t(), boolean_opt(), client_opt()) :: return()
activate_appendix activates an appendix.
add_contact(contact, validation \\ true, pre_verify \\ true, client \\ Client.new())
View SourceSpecs
add_contact(keyword(), boolean_opt(), boolean_opt(), client_opt()) :: return()
add_contact adds a new contact and returns a contact handle.
add_domain(domain, owner, admin, tech, bill, nameservers \\ [], opts \\ [], client \\ Client.new())
View SourceSpecs
add_domain( String.t(), String.t(), String.t(), String.t(), String.t(), [String.t()] | nil, keyword() | nil, client_opt() ) :: return()
add_domain registers a new domain.
Specs
add_nameserver(String.t(), [String.t()], client_opt()) :: return()
add_nameserver adds a nameservers to be used for nameserverging domains or zones.
add_tag(tag, description \\ "", type \\ "domain", client \\ Client.new())
View SourceSpecs
add_tag(String.t(), string_opt(), string_opt(), client_opt()) :: return()
add_tag adds a tags to be used for tagging domains or zones.
Specs
check_domain(String.t(), client_opt()) :: return()
check_domain checks wether the given domain name is free.
Specs
check_nameserver(String.t(), client_opt()) :: return()
check_nameserver checks a the given nameserver.
Specs
clone_contact(String.t(), client_opt()) :: return()
clone_contact clones the given contact.
convert_currency(amount, from, to \\ "EUR", client \\ Client.new())
View SourceSpecs
convert_currency(any(), String.t(), string_opt(), client_opt()) :: return()
convert_currency converts the currency according to their current rates.
Specs
delete_contact(String.t(), client_opt()) :: return()
delete_contact deletes a given contact.
delete_domain(domain, action \\ "instant", client \\ Client.new())
View SourceSpecs
delete_domain(String.t(), string_opt(), client_opt()) :: return()
delete_domain deletes a registered domain.
Specs
delete_event(String.t(), client_opt()) :: return()
delete_event deletes the given event by id.
Specs
delete_nameserver(String.t(), client_opt()) :: return()
delete_nameserver deletes a the given nameserver.
Specs
delete_tag(String.t(), string_opt(), client_opt()) :: return()
delete_tag deletes a the given tag.
Specs
get_zone(String.t(), client_opt()) :: return()
get_zone returns the correct zone for the given domainname.
Specs
get_zone_info(String.t(), client_opt()) :: return()
get_zone_info returns zone information for the given zone.
modify_contact(contact, validation \\ true, pre_verify \\ false, check_only \\ false, client \\ Client.new())
View SourceSpecs
modify_contact( keyword(), boolean_opt(), boolean_opt(), boolean_opt(), client_opt() ) :: return()
modify_contact modifies an existing contact and returns a contact handle.
Specs
modify_domain(String.t(), [String.t()] | nil, client_opt()) :: return()
modify_domain modifies domains by the given domain name for domains and zones.
Specs
modify_nameserver(String.t(), [String.t()], client_opt()) :: return()
modify_nameserver modifies nameservers by the given nameserver name for domains and zones.
Specs
modify_registrar(keyword(), client_opt()) :: return()
modify_registrar modifies the registrar's (or subaccounts) settings.
Specs
modify_tag(String.t(), keyword(), string_opt(), client_opt()) :: return()
modify_tag modifies tags by the given tag name for domains and zones.
query_accounting_list(date, offset \\ 0, limit \\ 2000, client \\ Client.new())
View SourceSpecs
query_accounting_list(String.t(), integer_opt(), integer_opt(), client_opt()) :: return()
query_accounting_list returns all items for accounting since the given date.
query_appendix_list(offset \\ 0, limit \\ 1000, client \\ Client.new())
View SourceSpecs
query_appendix_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_appendix_list returns a list of all appendices.
query_available_promotion_list(offset \\ 0, limit \\ 2000, client \\ Client.new())
View SourceSpecs
query_available_promotion_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_available_promotion_list returns all available promotions.
query_contact_list(offset \\ 0, limit \\ 100, client \\ Client.new())
View SourceSpecs
query_contact_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_contact_list returns a list of all contact handles.
query_domain_list(offset \\ 0, limit \\ 1000, client \\ Client.new())
View SourceSpecs
query_domain_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_domain_list returns a list of all registerd domains.
query_event_list(date, opts \\ [], offset \\ 0, limit \\ 1000, client \\ Client.new())
View SourceSpecs
query_event_list( String.t(), keyword() | nil, integer_opt(), integer_opt(), client_opt() ) :: return()
query_event_list returns a list of events since the given date.
query_foreign_transfer_list(offset \\ 0, limit \\ 2000, client \\ Client.new())
View SourceSpecs
query_foreign_transfer_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_foreign_transfer_list returns a list of foreign transfers.
query_nameserver_list(offset \\ 0, limit \\ 1000, client \\ Client.new())
View SourceSpecs
query_nameserver_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_nameserver_list gets a list of nameservers.
query_tag_list(type \\ "domain", offset \\ 0, limit \\ 1000, client \\ Client.new())
View SourceSpecs
query_tag_list(string_opt(), integer_opt(), integer_opt(), client_opt()) :: return()
query_tag_list gets a list of tags.
query_transfer_list(offset \\ 0, limit \\ 2000, client \\ Client.new())
View SourceSpecs
query_transfer_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_transfer_list returns a list of local transfers.
query_upcoming_accounting_list(offset \\ 0, limit \\ 2000, client \\ Client.new())
View SourceSpecs
query_upcoming_accounting_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_upcoming_accounting_list returns all items that are upcoming for accounting.
query_zone_list(offset \\ 0, limit \\ 2000, client \\ Client.new())
View SourceSpecs
query_zone_list(integer_opt(), integer_opt(), client_opt()) :: return()
query_zone_list returns the prices per zone.
Specs
renew_domain(String.t(), integer_opt(), client_opt()) :: return()
renew_domain renews a registered domain.
Specs
request_token(String.t(), client_opt()) :: return()
request_token requests a verification token for the given contact or domain.
Specs
restore_contact(String.t(), client_opt()) :: return()
restore_contact restores a deleted contact.
Specs
restore_domain(String.t(), client_opt()) :: return()
restore_domain restores a registered domain.
Specs
set_domain_auth_code(String.t(), String.t(), client_opt()) :: return()
set_auth_code sets the domains auth-code for transfer.
set_domain_renewal_mode(domain, mode \\ "default", token \\ "", client \\ Client.new())
View SourceSpecs
set_domain_renewal_mode(String.t(), string_opt(), string_opt(), client_opt()) :: return()
set_domain_renewal_mode sets the domains renewal-mode.
The domains mode for renewals (optional): DEFAULT | AUTORENEW | AUTOEXPIRE | AUTODELETE | RENEWONCE The domains mode for renewals (only valid for the zone de, optional): DEFAULT | AUTORENEW | AUTORENEWMONTHLY | AUTOEXPIRE | AUTODELETE | RENEWONCE The domains mode for renewals (only valid for the zone nl, optional): DEFAULT | AUTORENEW | AUTOEXPIRE | AUTODELETE | RENEWONCE | AUTORENEWQUARTERLY The domains mode for renewals (only valid for the zones com, net, org, info, biz, tv, mobi and me, optional): DEFAULT | AUTORENEW | AUTOEXPIRE | AUTODELETE | RENEWONCE | EXPIREAUCTION
set_domain_transfer_mode(domain, mode \\ "default", token \\ "", client \\ Client.new())
View SourceSpecs
set_domain_transfer_mode(String.t(), string_opt(), string_opt(), client_opt()) :: return()
set_domain_transfer_mode sets the domains transfer-mode.
The domains mode for transfers: DEFAULT|AUTOAPPROVE|AUTODENY
Specs
status_account(client_opt()) :: return()
status_account returns information about the accounts financial status.
Specs
status_contact(String.t(), client_opt()) :: return()
get_contact returns a contact handle.
Specs
status_domain(String.t(), client_opt()) :: return()
status_domain gets the given domain by name.
Specs
status_domain_transfer(String.t(), client_opt()) :: return()
status_domain_transfer command informs you about the current status of a transfer. You can check if the transfer was successfully initiated or who received the eMail to confirm a transfer.
Specs
status_event(String.t(), client_opt()) :: return()
status_event gets an event by id.
Specs
status_nameserver(String.t(), client_opt()) :: return()
status_nameserver gets the given nameserver by name.
Specs
status_owner_change(String.t(), client_opt()) :: return()
status_owner_change explicity checks the status of an OwnerChange in detail.
Specs
status_registrar(client_opt()) :: return()
status_registrar returns information about your account information.
Specs
status_tag(String.t(), string_opt(), client_opt()) :: return()
status_tag gets the given tag by name.
transfer_domain(domain, action \\ "request", auth \\ "", owner \\ "", admin \\ "", tech \\ "", bill \\ "", nameservers \\ [], opts \\ [], client \\ Client.new())
View SourceSpecs
transfer_domain( String.t(), string_opt(), string_opt(), string_opt(), string_opt(), string_opt(), string_opt(), [String.t()] | nil, keyword() | nil, client_opt() ) :: return()
transfer_domain transfers a foreign domain into our account.