C# Class DNSimple.DNSimpleRestClient

Mostrar archivo Open project: anderly/dnsimple-csharp Class Usage Examples

Public Methods

Method	Description
AddContact ( string first_name, string last_name, string address1, string city, string state_province, string postal_code, string country, string email_address, string phone, string organization_name = null, string job_title = null, string fax = null, string phone_ext = null, string label = null, string address2 = null ) : dynamic	Create a contact. Makes a POST request to the Contacts List resource.
AddDomain ( string name ) : dynamic	Create a single domain in your DNSimple account. Makes a POST request to the Domains List resource.
AddMember ( int domainId, string email ) : dynamic	Add another DNSimple customer to a domain's memberships. Domain members have the privilege of managing a domain's records and templates. Makes a POST request to the Domain Memberships List resource. You must provide an email address for the person to add. If the person already exists in DNSimple as a customer then they will immediately be added to the domain's membership list. If the person does not yet have a DNSimple account then they will receive an invitation to join via email.
AddMember ( string domain, string email ) : dynamic	Add another DNSimple customer to a domain's memberships. Domain members have the privilege of managing a domain's records and templates. Makes a POST request to the Domain Memberships List resource. You must provide an email address for the person to add. If the person already exists in DNSimple as a customer then they will immediately be added to the domain's membership list. If the person does not yet have a DNSimple account then they will receive an invitation to join via email.
AddRecord ( int domainId, string name, string record_type, string content, int ttl = null, int priority = null ) : dynamic	Create a record for the given domain. Makes a POST request to the Domain Records List resource.
AddRecord ( string domain, string name, string record_type, string content, int ttl = null, int priority = null ) : dynamic	Create a record for the given domain. Makes a POST request to the Domain Records List resource.
AddService ( int id, int service_id ) : dynamic	Add a service to a domain. Makes a POST request to the Domain Applied Services List resource.
AddService ( string domain, int service_id ) : dynamic	Add a service to a domain. Makes a POST request to the Domain Applied Services List resource.
AddWhoisPrivacyProtection ( int id ) : dynamic
AddWhoisPrivacyProtection ( string name ) : dynamic	Turn on WHOIS Privacy Protection. If WHOIS Privacy Protection has not yet been purchased then invoking this will purchase the service and enable it. If the privacy protection is currently disabled then it will be enabled. Makes a POST request to the Domains WHOIS resource.
CheckDomain ( string name ) : dynamic	Check if the specified domain is available for registration. Makes a GET request the Domains Check resource (/domains/{name}/check).
DeleteContact ( int id ) : dynamic	Delete a single Contact in your DNSimple account. Makes a DELETE request to the Contacts resource.
DeleteDomain ( int id ) : dynamic
DeleteDomain ( string name ) : dynamic	Delete a single domain in your DNSimple account. Makes a DELETE request a Domain Instance resource.
DeleteRecord ( int id, int record_id ) : dynamic	Remove a DNS Record from a domain. Makes a DELETE request to the Domain DNS Records Instance resource.
DeleteRecord ( string domain, int record_id ) : dynamic	Remove a DNS Record from a domain. Makes a DELETE request to the Domain DNS Records Instance resource.
DeleteService ( int id, int service_id ) : dynamic	Remove a service from a domain. Makes a DELETE request to the Domain Applied Services Instance resource.
DeleteService ( string domain, int service_id ) : dynamic	Remove a service from a domain. Makes a DELETE request to the Domain Applied Services Instance resource.
GetContact ( int id ) : dynamic	Retrieve the details for a specific Contact. Makes a GET request to the Contact resource.
GetDomain ( int id ) : dynamic
GetDomain ( string name ) : dynamic	Retrieve the details for a specific Domain Instance. Makes a GET request to an Domain Instance resource.
GetExtendedAttributes ( string tld ) : dynamic	Retrieve the extended attributes required for a specific top level domain. Makes a GET request to the Extended Attributes resource.
GetRecord ( int domainId, int record_id ) : dynamic	Retrieve the details for a specific Domain DNS Record Instance. Makes a GET request to an DNS Record Instance resource.
GetRecord ( string domain, int record_id ) : dynamic	Retrieve the details for a specific Domain DNS Record Instance. Makes a GET request to an DNS Record Instance resource.
GetService ( int id ) : dynamic	Retrieve the details for a specific Service Instance. Makes a GET request to an Service Instance resource.
GetStatements ( ) : dynamic	Retrieve the statements for this account. Makes a GET request to the Statements resource.
ListAppliedServices ( int id ) : dynamic	List services already applied to a domain. Makes a GET request to an Domain Applied Services List resource.
ListAppliedServices ( string domain ) : dynamic	List services already applied to a domain. Makes a GET request to an Domain Applied Services List resource.
ListAvailableServices ( int id ) : dynamic	List services available for to a domain. Makes a GET request to an Domain Available Services List resource.
ListAvailableServices ( string domain ) : dynamic	List services available for a domain. Makes a GET request to an Domain Available Services List resource.
ListContacts ( ) : dynamic	Returns a list of Contacts.
ListDomains ( ) : dynamic	Returns a list of Domains. The list includes paging information. Makes a GET request to the Domains List resource.
ListMembers ( int domainId ) : dynamic	List all of the current members for a domain. Domain members have the privilege of managing a domain's records and templates. Makes a GET request to the Domain Memberships List resource.
ListMembers ( string domain ) : dynamic	List all of the current members for a domain. Domain members have the privilege of managing a domain's records and templates. Makes a GET request to the Domain Memberships List resource.
ListRecords ( int id ) : dynamic	Get the list of DNS records for the specific domain. Makes a GET request to an Domain DNS Records List resource.
ListRecords ( string domain ) : dynamic	Get the list of DNS records for the specific domain. Makes a GET request to an Domain DNS Records List resource.
ListServices ( ) : dynamic	Get a list of all services supported. Makes a GET request to the Services List resource.
RegisterDomain ( string name, int registrant_id ) : dynamic	Register a domain name with DNSimple and the appropriate domain registry. Makes a POST request to the Domain Registrations resource (domain_registrations). Your account must already be active for this command to complete successfully. You will be automatically charged the 1 year registration fee upon successful registration, so please be careful with this command.
RemoveMember ( int domainId, string email ) : dynamic	Remove a DNSimple customer from the membership list for a domain. Makes a DELETE request to the Domain Membership Instance resource. The customer will no longer be able to manage the domain.
RemoveMember ( string domain, string email ) : dynamic	Remove a DNSimple customer from the membership list for a domain. Makes a DELETE request to the Domain Membership Instance resource. The customer will no longer be able to manage the domain.
RemoveVanityNameServers ( string domain ) : dynamic	Disable vanity name servers for the given domain. Makes a DELETE request to the Vanity Name Servers resource (domains/{id_or_name}/vanity_name_servers).
RemoveWhoisPrivacyProtection ( int id ) : dynamic
RemoveWhoisPrivacyProtection ( string name ) : dynamic	Turn off WHOIS Privacy Protection. If the privacy protection has not expired it can always be turned back on with no additional charge. Makes a DELETE request a Domains WHOIS resource.
RenewDomain ( string name, bool renew_whois_privacy = false ) : dynamic	Renew a domain name in your account. Makes a POST request the Domain Renewal resource (domain_renewal). This will renew the domain for 1 year.
SetNameServers ( string name ) : dynamic	Change the name servers either to external name servers or back to DNSimple's name servers. Makes a POST request the Name Servers resource (domains/{id_or_name}/name_servers). This API accepts up to 6 name servers.
SetVanityNameServers ( string domain, ServerSource server_source ) : dynamic	Enable vanity name servers for the given domain. Makes a POST request to the Vanity Name Servers resource (domains/{id_or_name}/vanity_name_servers). You may use up to 4 external name servers (ns1 through ns4)
TransferDomain ( string name, int registrant_id, string authinfo = null ) : dynamic	Transfer a domain name from another domain registrar into DNSimple. Makes a POST request the Domain Transfer resource (domain_transfers). Your account must already be active for this command to complete successfully. You will be automatically charged the 1 year transfer fee upon successful transfer of the domain, which may take anywhere from a few minutes up to 7 days. Only domains that do not require extended attributes may be transferred through the API at this time. For example, domains ending in .com and .net may be transferred through the API, however domains ending in .us and .ca may not.
UpdateContact ( int id, string first_name, string last_name, string address1, string city, string state_province, string postal_code, string country, string email_address, string phone, string organization_name = null, string job_title = null, string fax = null, string phone_ext = null, string label = null, string address2 = null ) : dynamic	Updates an existing Contact. Makes a PUT request to the Contacts List resource.
UpdateRecord ( int domainId, int record_id, string name, string content, int ttl = null, int priority = null ) : dynamic	Update the given record for the given domain. Makes a PUT request to the Domain Records Instance resource.
UpdateRecord ( string domain, int record_id, string name, string content, int ttl = null, int priority = null ) : dynamic	Update the given record for the given domain. Makes a PUT request to the Domain Records Instance resource.

Method Details

AddContact() public method

Create a contact. Makes a POST request to the Contacts List resource.

public AddContact ( string first_name, string last_name, string address1, string city, string state_province, string postal_code, string country, string email_address, string phone, string organization_name = null, string job_title = null, string fax = null, string phone_ext = null, string label = null, string address2 = null ) : dynamic
first_name	string	First Name
last_name	string	Last Name
address1	string	Address Line 1
city	string	City
state_province	string	State or Province
postal_code	string	Postal Code
country	string	Country
email_address	string	Email Address
phone	string	Phone Number
organization_name	string	Optional Organisation Name
job_title	string	Optional Job Title (Required if organisation_name specified)
fax	string	Optional Fax Number
phone_ext	string	Optional Phone Extension
label	string	Optional Label for this Contact
address2	string	Address Line 2
return	dynamic

AddDomain() public method

Create a single domain in your DNSimple account. Makes a POST request to the Domains List resource.

public AddDomain ( string name ) : dynamic
name	string	The name of the domain.
return	dynamic

AddMember() public method

Add another DNSimple customer to a domain's memberships. Domain members have the privilege of managing a domain's records and templates. Makes a POST request to the Domain Memberships List resource.

You must provide an email address for the person to add. If the person already exists in DNSimple as a customer then they will immediately be added to the domain's membership list. If the person does not yet have a DNSimple account then they will receive an invitation to join via email.

public AddMember ( int domainId, string email ) : dynamic
domainId	int	The ID of the domain for which to retrieve the members
email	string	The email for the user to add as a member to this domain
return	dynamic

AddMember() public method

Add another DNSimple customer to a domain's memberships. Domain members have the privilege of managing a domain's records and templates. Makes a POST request to the Domain Memberships List resource.

public AddMember ( string domain, string email ) : dynamic
domain	string	The domain for which to retrieve the members
email	string	The email for the user to add as a member to this domain
return	dynamic

AddRecord() public method

Create a record for the given domain. Makes a POST request to the Domain Records List resource.

public AddRecord ( int domainId, string name, string record_type, string content, int ttl = null, int priority = null ) : dynamic
domainId	int	The ID of the domain
name	string	The name of the DNS record
record_type	string	The type of the DNS record (A, CNAME, MX, etc.)
content	string	The value of the DNS record
ttl	int	The optional TTL (Time-To-Live) for this DNS record
priority	int	The optional priority for this DNS record
return	dynamic

AddRecord() public method

Create a record for the given domain. Makes a POST request to the Domain Records List resource.

public AddRecord ( string domain, string name, string record_type, string content, int ttl = null, int priority = null ) : dynamic
domain	string	The name of the domain
name	string	The name of the DNS record
record_type	string	The type of the DNS record (A, CNAME, MX, etc.)
content	string	The value of the DNS record
ttl	int	The optional TTL (Time-To-Live) for this DNS record
priority	int	The optional priority for this DNS record
return	dynamic

AddService() public method

Add a service to a domain. Makes a POST request to the Domain Applied Services List resource.

public AddService ( int id, int service_id ) : dynamic
id	int	The ID of the domain
service_id	int	The ID of service to add to the domain
return	dynamic

AddService() public method

Add a service to a domain. Makes a POST request to the Domain Applied Services List resource.

public AddService ( string domain, int service_id ) : dynamic
domain	string	The name of the domain
service_id	int	The ID of service to add to the domain
return	dynamic

AddWhoisPrivacyProtection() public method

public AddWhoisPrivacyProtection ( int id ) : dynamic
id	int
return	dynamic

AddWhoisPrivacyProtection() public method

Turn on WHOIS Privacy Protection. If WHOIS Privacy Protection has not yet been purchased then invoking this will purchase the service and enable it. If the privacy protection is currently disabled then it will be enabled. Makes a POST request to the Domains WHOIS resource.

public AddWhoisPrivacyProtection ( string name ) : dynamic
name	string	The name of the domain.
return	dynamic

CheckDomain() public method

Check if the specified domain is available for registration. Makes a GET request the Domains Check resource (/domains/{name}/check).

public CheckDomain ( string name ) : dynamic
name	string	The Name of the domain to check
return	dynamic

DeleteContact() public method

Delete a single Contact in your DNSimple account. Makes a DELETE request to the Contacts resource.

public DeleteContact ( int id ) : dynamic
id	int
return	dynamic

DeleteDomain() public method

public DeleteDomain ( int id ) : dynamic
id	int
return	dynamic

DeleteDomain() public method

Delete a single domain in your DNSimple account. Makes a DELETE request a Domain Instance resource.

public DeleteDomain ( string name ) : dynamic
name	string	The name of the domain.
return	dynamic

DeleteRecord() public method

Remove a DNS Record from a domain. Makes a DELETE request to the Domain DNS Records Instance resource.

public DeleteRecord ( int id, int record_id ) : dynamic
id	int	The ID of the domain
record_id	int	The ID of DNS Record to remove from the domain
return	dynamic

DeleteRecord() public method

Remove a DNS Record from a domain. Makes a DELETE request to the Domain DNS Records Instance resource.

public DeleteRecord ( string domain, int record_id ) : dynamic
domain	string	The domain of the domain
record_id	int	The ID of DNS Record to remove from the domain
return	dynamic

DeleteService() public method

Remove a service from a domain. Makes a DELETE request to the Domain Applied Services Instance resource.

public DeleteService ( int id, int service_id ) : dynamic
id	int	The ID of the domain
service_id	int	The ID of service to remove from the domain
return	dynamic

DeleteService() public method

Remove a service from a domain. Makes a DELETE request to the Domain Applied Services Instance resource.

public DeleteService ( string domain, int service_id ) : dynamic
domain	string	The name of the domain
service_id	int	The ID of service to remove from the domain
return	dynamic

GetContact() public method

Retrieve the details for a specific Contact. Makes a GET request to the Contact resource.

public GetContact ( int id ) : dynamic
id	int	The id of the contact to retrieve
return	dynamic

GetDomain() public method

public GetDomain ( int id ) : dynamic
id	int
return	dynamic

GetDomain() public method

Retrieve the details for a specific Domain Instance. Makes a GET request to an Domain Instance resource.

public GetDomain ( string name ) : dynamic
name	string	The Name of the domain to retrieve
return	dynamic

GetExtendedAttributes() public method

Retrieve the extended attributes required for a specific top level domain. Makes a GET request to the Extended Attributes resource.

public GetExtendedAttributes ( string tld ) : dynamic
tld	string
return	dynamic

GetRecord() public method

Retrieve the details for a specific Domain DNS Record Instance. Makes a GET request to an DNS Record Instance resource.

public GetRecord ( int domainId, int record_id ) : dynamic
domainId	int	The ID of the domain for which to retrieve the DNS record
record_id	int	The ID of the DNS record to retrieve
return	dynamic

GetRecord() public method

Retrieve the details for a specific Domain DNS Record Instance. Makes a GET request to an DNS Record Instance resource.

public GetRecord ( string domain, int record_id ) : dynamic
domain	string	The name of the domain for which to retrieve the DNS record
record_id	int	The ID of the DNS record to retrieve
return	dynamic

GetService() public method

Retrieve the details for a specific Service Instance. Makes a GET request to an Service Instance resource.

public GetService ( int id ) : dynamic
id	int	The ID of the service to retrieve
return	dynamic

GetStatements() public method

Retrieve the statements for this account. Makes a GET request to the Statements resource.

public GetStatements ( ) : dynamic
return	dynamic

ListAppliedServices() public method

List services already applied to a domain. Makes a GET request to an Domain Applied Services List resource.

public ListAppliedServices ( int id ) : dynamic
id	int	The ID the domain for which to retrieve the applied services
return	dynamic

ListAppliedServices() public method

List services already applied to a domain. Makes a GET request to an Domain Applied Services List resource.

public ListAppliedServices ( string domain ) : dynamic
domain	string	The name of the domain for which to retrieve the applied services
return	dynamic

ListAvailableServices() public method

List services available for to a domain. Makes a GET request to an Domain Available Services List resource.

public ListAvailableServices ( int id ) : dynamic
id	int	The ID the domain for which to retrieve the available services
return	dynamic

ListAvailableServices() public method

List services available for a domain. Makes a GET request to an Domain Available Services List resource.

public ListAvailableServices ( string domain ) : dynamic
domain	string	The name of the domain for which to retrieve the available services
return	dynamic

ListContacts() public method

Returns a list of Contacts.

public ListContacts ( ) : dynamic
return	dynamic

ListDomains() public method

Returns a list of Domains. The list includes paging information. Makes a GET request to the Domains List resource.

public ListDomains ( ) : dynamic
return	dynamic

ListMembers() public method

List all of the current members for a domain. Domain members have the privilege of managing a domain's records and templates. Makes a GET request to the Domain Memberships List resource.

public ListMembers ( int domainId ) : dynamic
domainId	int	The ID of the domain for which to retrieve the members
return	dynamic

ListMembers() public method

List all of the current members for a domain. Domain members have the privilege of managing a domain's records and templates. Makes a GET request to the Domain Memberships List resource.

public ListMembers ( string domain ) : dynamic
domain	string	The domain for which to retrieve the members
return	dynamic

ListRecords() public method

Get the list of DNS records for the specific domain. Makes a GET request to an Domain DNS Records List resource.

public ListRecords ( int id ) : dynamic
id	int	The ID of the domain for which to retrieve the DNS records
return	dynamic

ListRecords() public method

Get the list of DNS records for the specific domain. Makes a GET request to an Domain DNS Records List resource.

public ListRecords ( string domain ) : dynamic
domain	string	The name of the domain for which to retrieve the DNS records
return	dynamic

ListServices() public method

Get a list of all services supported. Makes a GET request to the Services List resource.

public ListServices ( ) : dynamic
return	dynamic

RegisterDomain() public method

Register a domain name with DNSimple and the appropriate domain registry. Makes a POST request to the Domain Registrations resource (domain_registrations).

Your account must already be active for this command to complete successfully. You will be automatically charged the 1 year registration fee upon successful registration, so please be careful with this command.

public RegisterDomain ( string name, int registrant_id ) : dynamic
name	string	The domain name to register
registrant_id	int	ID for an existing account contact
return	dynamic

RemoveMember() public method

Remove a DNSimple customer from the membership list for a domain. Makes a DELETE request to the Domain Membership Instance resource.

The customer will no longer be able to manage the domain.

public RemoveMember ( int domainId, string email ) : dynamic
domainId	int	The ID of the domain for which to retrieve the members
email	string	The email for the user to add as a member to this domain
return	dynamic

RemoveMember() public method

Remove a DNSimple customer from the membership list for a domain. Makes a DELETE request to the Domain Membership Instance resource.

The customer will no longer be able to manage the domain.

public RemoveMember ( string domain, string email ) : dynamic
domain	string	The domain for which to retrieve the members
email	string	The email for the user to add as a member to this domain
return	dynamic

RemoveVanityNameServers() public method

Disable vanity name servers for the given domain. Makes a DELETE request to the Vanity Name Servers resource (domains/{id_or_name}/vanity_name_servers).

public RemoveVanityNameServers ( string domain ) : dynamic
domain	string	The domain for which to remove the vanity name servers
return	dynamic

RemoveWhoisPrivacyProtection() public method

public RemoveWhoisPrivacyProtection ( int id ) : dynamic
id	int
return	dynamic

RemoveWhoisPrivacyProtection() public method

Turn off WHOIS Privacy Protection. If the privacy protection has not expired it can always be turned back on with no additional charge. Makes a DELETE request a Domains WHOIS resource.

public RemoveWhoisPrivacyProtection ( string name ) : dynamic
name	string	The name of the domain.
return	dynamic

RenewDomain() public method

Renew a domain name in your account. Makes a POST request the Domain Renewal resource (domain_renewal).

This will renew the domain for 1 year.

public RenewDomain ( string name, bool renew_whois_privacy = false ) : dynamic
name	string	The domain name to renew
renew_whois_privacy	bool	Whether to renew the Whois Privacy Service
return	dynamic

SetNameServers() public method

Change the name servers either to external name servers or back to DNSimple's name servers. Makes a POST request the Name Servers resource (domains/{id_or_name}/name_servers).

This API accepts up to 6 name servers.

public SetNameServers ( string name ) : dynamic
name	string	The domain for which to set the name servers
return	dynamic

SetVanityNameServers() public method

Enable vanity name servers for the given domain. Makes a POST request to the Vanity Name Servers resource (domains/{id_or_name}/vanity_name_servers).

You may use up to 4 external name servers (ns1 through ns4)

public SetVanityNameServers ( string domain, ServerSource server_source ) : dynamic
domain	string	The domain for which to set the name servers
server_source	ServerSource	ServerSource ["dnsimple" or "external"]
return	dynamic

TransferDomain() public method

Transfer a domain name from another domain registrar into DNSimple. Makes a POST request the Domain Transfer resource (domain_transfers).

Your account must already be active for this command to complete successfully. You will be automatically charged the 1 year transfer fee upon successful transfer of the domain, which may take anywhere from a few minutes up to 7 days. Only domains that do not require extended attributes may be transferred through the API at this time. For example, domains ending in .com and .net may be transferred through the API, however domains ending in .us and .ca may not.

public TransferDomain ( string name, int registrant_id, string authinfo = null ) : dynamic
name	string	The domain name to transfer
registrant_id	int	ID for an existing contact
authinfo	string
return	dynamic

UpdateContact() public method

Updates an existing Contact. Makes a PUT request to the Contacts List resource.

public UpdateContact ( int id, string first_name, string last_name, string address1, string city, string state_province, string postal_code, string country, string email_address, string phone, string organization_name = null, string job_title = null, string fax = null, string phone_ext = null, string label = null, string address2 = null ) : dynamic
id	int	The id of the Contact to Update
first_name	string	First Name
last_name	string	Last Name
address1	string	Address Line 1
city	string	City
state_province	string	State or Province
postal_code	string	Postal Code
country	string	Country
email_address	string	Email Address
phone	string	Phone Number
organization_name	string	Optional Organisation Name
job_title	string	Optional Job Title (Required if organisation_name specified)
fax	string	Optional Fax Number
phone_ext	string	Optional Phone Extension
label	string	Optional Label for this Contact
address2	string	Address Line 2
return	dynamic

UpdateRecord() public method

Update the given record for the given domain. Makes a PUT request to the Domain Records Instance resource.

public UpdateRecord ( int domainId, int record_id, string name, string content, int ttl = null, int priority = null ) : dynamic
domainId	int
record_id	int	The ID of the DNS record to affect
name	string	The name of the DNS record
content	string	The value of the DNS record
ttl	int	The optional TTL (Time-To-Live) for this DNS record
priority	int	The optional priority for this DNS record
return	dynamic

UpdateRecord() public method

Update the given record for the given domain. Makes a PUT request to the Domain Records Instance resource.

public UpdateRecord ( string domain, int record_id, string name, string content, int ttl = null, int priority = null ) : dynamic
domain	string	The name of the domain
record_id	int	The ID of the DNS record to affect
name	string	The name of the DNS record
content	string	The value of the DNS record
ttl	int	The optional TTL (Time-To-Live) for this DNS record
priority	int	The optional priority for this DNS record
return	dynamic