Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/dnsimple/client/billing.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module Billing
# List the billing charges for the account.
#
# @see https://developer.dnsimple.com/v2/billing/#listCharges
# @see https://developer.dnsimple.com/v2/billing-charges/#listCharges
#
# @example List charges in the first page
# client.charges.list(1010)
Expand Down
12 changes: 6 additions & 6 deletions lib/dnsimple/client/contacts.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module Contacts
# Lists the contacts in the account.
#
# @see https://developer.dnsimple.com/v2/contacts/#list
# @see https://developer.dnsimple.com/v2/contacts/#listContacts
# @see #all_contacts
#
# @example List contacts in the first page
Expand Down Expand Up @@ -40,7 +40,7 @@ def contacts(account_id, options = {})
# Please use this method carefully, as fetching the entire collection will increase the number of requests
# you send to the API server and you may eventually risk to hit the throttle limit.
#
# @see https://developer.dnsimple.com/v2/contacts/#list
# @see https://developer.dnsimple.com/v2/contacts/#listContacts
# @see #contacts
#
# @param account_id [Integer] the account ID
Expand All @@ -57,7 +57,7 @@ def all_contacts(account_id, options = {})

# Creates a contact in the account.
#
# @see https://developer.dnsimple.com/v2/contacts/#create
# @see https://developer.dnsimple.com/v2/contacts/#createContact
#
# @param account_id [Integer] the account ID
# @param attributes [Hash]
Expand All @@ -74,7 +74,7 @@ def create_contact(account_id, attributes, options = {})

# Gets a contact from the account.
#
# @see https://developer.dnsimple.com/v2/contacts/#get
# @see https://developer.dnsimple.com/v2/contacts/#getContact
#
# @param account_id [Integer] the account ID
# @param contact_id [#to_s] the contact ID
Expand All @@ -91,7 +91,7 @@ def contact(account_id, contact_id, options = {})

# Updates a contact in the account.
#
# @see https://developer.dnsimple.com/v2/contacts/#update
# @see https://developer.dnsimple.com/v2/contacts/#updateContact
#
# @param account_id [Integer] the account ID
# @param contact_id [#to_s] the contact ID
Expand All @@ -110,7 +110,7 @@ def update_contact(account_id, contact_id, attributes, options = {})
#
# WARNING: this cannot be undone.
#
# @see https://developer.dnsimple.com/v2/contacts/#delete
# @see https://developer.dnsimple.com/v2/contacts/#deleteContact
#
# @param account_id [Integer] the account ID
# @param contact_id [#to_s] the contact ID
Expand Down
10 changes: 5 additions & 5 deletions lib/dnsimple/client/domains_delegation_signer_records.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module DomainsDelegationSignerRecords
# Lists the delegation signer records for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list
# @see https://developer.dnsimple.com/v2/domains/dnssec/#listDomainDelegationSignerRecords
#
# @example List delegation signer records in the first page
# client.domains.delegation_signer_records(1010, "example.com")
Expand Down Expand Up @@ -40,7 +40,7 @@ def delegation_signer_records(account_id, domain_id, options = {})
# Please use this method carefully, as fetching the entire collection will increase the number of requests
# you send to the API server and you may eventually risk to hit the throttle limit.
#
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list
# @see https://developer.dnsimple.com/v2/domains/dnssec/#listDomainDelegationSignerRecords
# @see #email_forwards
#
# @param account_id [Integer] the account ID
Expand All @@ -58,7 +58,7 @@ def all_delegation_signer_records(account_id, domain_id, options = {})

# Creates a delegation signer record for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-create
# @see https://developer.dnsimple.com/v2/domains/dnssec/#createDomainDelegationSignerRecord
# @see http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
# @see http://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml
#
Expand All @@ -83,7 +83,7 @@ def create_delegation_signer_record(account_id, domain_id, attributes, options =

# Gets a delegation signer record for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-get
# @see https://developer.dnsimple.com/v2/domains/dnssec/#getDomainDelegationSignerRecord
#
# @param account_id [Integer] the account ID
# @param domain_id [#to_s] The domain ID or domain name
Expand All @@ -103,7 +103,7 @@ def delegation_signer_record(account_id, domain_id, ds_record_id, options = {})
#
# WARNING: this cannot be undone.
#
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-delete
# @see https://developer.dnsimple.com/v2/domains/dnssec/#deleteDomainDelegationSignerRecord
#
# @param account_id [Integer] the account ID
# @param domain_id [#to_s] The domain ID or domain name
Expand Down
6 changes: 3 additions & 3 deletions lib/dnsimple/client/domains_dnssec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module DomainsDnssec
# Enable DNSSEC for the domain in the account.
#
# @see https://developer.dnsimple.com/v2/dnssec/#enable
# @see https://developer.dnsimple.com/v2/domains/dnssec/#enableDomainDnssec
#
# @param account_id [Integer] the account ID
# @param domain_name [#to_s] the domain name
Expand All @@ -22,7 +22,7 @@ def enable_dnssec(account_id, domain_name, options = {})

# Disable DNSSEC for the domain in the account.
#
# @see https://developer.dnsimple.com/v2/dnssec/#disable
# @see https://developer.dnsimple.com/v2/domains/dnssec/#disableDomainDnssec
#
# @param account_id [Integer] the account ID
# @param domain_name [#to_s] the domain name
Expand All @@ -39,7 +39,7 @@ def disable_dnssec(account_id, domain_name, options = {})

# Get the DNSSEC status for the domain in the account.
#
# @see https://developer.dnsimple.com/v2/dnssec/#get
# @see https://developer.dnsimple.com/v2/domains/dnssec/#getDomainDnssec
#
# @param account_id [Integer] the account ID
# @param domain_name [#to_s] the domain name
Expand Down
10 changes: 5 additions & 5 deletions lib/dnsimple/client/domains_email_forwards.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module DomainsEmailForwards
# Lists the email forwards for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#list
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#listEmailForwards
#
# @example List email forwards in the first page
# client.domains.email_forwards(1010, "example.com")
Expand Down Expand Up @@ -40,7 +40,7 @@ def email_forwards(account_id, domain_id, options = {})
# Please use this method carefully, as fetching the entire collection will increase the number of requests
# you send to the API server and you may eventually risk to hit the throttle limit.
#
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#list
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#listEmailForwards
# @see #email_forwards
#
# @param account_id [Integer] the account ID
Expand All @@ -58,7 +58,7 @@ def all_email_forwards(account_id, domain_id, options = {})

# Creates an email forward for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#create
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#createEmailForward
#
# @param account_id [Integer] the account ID
# @param domain_id [#to_s] The domain ID or domain name
Expand All @@ -76,7 +76,7 @@ def create_email_forward(account_id, domain_id, attributes, options = {})

# Gets a email forward for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#get
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#getEmailForward
#
# @param account_id [Integer] the account ID
# @param domain_id [#to_s] The domain ID or domain name
Expand All @@ -96,7 +96,7 @@ def email_forward(account_id, domain_id, email_forward_id, options = {})
#
# WARNING: this cannot be undone.
#
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#delete
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#deleteEmailForward
#
# @param account_id [Integer] the account ID
# @param domain_id [#to_s] The domain ID or domain name
Expand Down
8 changes: 4 additions & 4 deletions lib/dnsimple/client/domains_pushes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module DomainsPushes
# Initiate a push for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/pushes/#initiate
# @see https://developer.dnsimple.com/v2/domains/pushes/#initiateDomainPush
#
# @example Initiate a domain push for example.com using a domain push identifier:
# client.domains.initiate_push(1010, "example.com", new_account_identifier: "abc123")
Expand All @@ -30,7 +30,7 @@ def initiate_push(account_id, domain_id, attributes, options = {})

# Lists the pushes for the domain.
#
# @see https://developer.dnsimple.com/v2/domains/pushes/#list
# @see https://developer.dnsimple.com/v2/domains/pushes/#listPushes
#
# @example List domain pushes in the first page
# client.domains.pushes(2020)
Expand All @@ -54,7 +54,7 @@ def pushes(account_id, options = {})

# Accept a domain push.
#
# @see https://developer.dnsimple.com/v2/domains/pushes/#accept
# @see https://developer.dnsimple.com/v2/domains/pushes/#acceptPush
#
# @example Accept a domain push in the target account:
# client.domains.accept_push(2020, 1, contact_id: 2)
Expand All @@ -77,7 +77,7 @@ def accept_push(account_id, push_id, attributes, options = {})

# Reject a domain push.
#
# @see https://developer.dnsimple.com/v2/domains/pushes/#reject
# @see https://developer.dnsimple.com/v2/domains/pushes/#rejectPush
#
# @example Reject a domain push in the target account:
# client.domains.reject_push(2020, 1, contact_id: 2)
Expand Down
12 changes: 6 additions & 6 deletions lib/dnsimple/client/registrar.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module Registrar
# Checks whether a domain is available to be registered.
#
# @see https://developer.dnsimple.com/v2/registrar/#check
# @see https://developer.dnsimple.com/v2/registrar/#checkDomain
#
# @example Check whether example.com is available:
# client.registrar.check_domain(1010, "example.com")
Expand Down Expand Up @@ -45,7 +45,7 @@ def get_domain_prices(account_id, domain_name, options = {})

# Registers a domain.
#
# @see https://developer.dnsimple.com/v2/registrar/#register
# @see https://developer.dnsimple.com/v2/registrar/#registerDomain
#
# @example Initiate the registration of example.com using the contact 1234 as registrant
# including WHOIS privacy for the domain and enabling auto renewal:
Expand Down Expand Up @@ -90,7 +90,7 @@ def get_domain_registration(account_id, domain_name, domain_registration_id, opt

# Renews a domain.
#
# @see https://developer.dnsimple.com/v2/registrar/#renew
# @see https://developer.dnsimple.com/v2/registrar/#renewDomain
#
# @example Renew example.com for 3 years:
# client.registrar.renew_domain(1010, "example.com", period: 3)
Expand Down Expand Up @@ -133,7 +133,7 @@ def get_domain_renewal(account_id, domain_name, domain_renewal_id, options = {})

# Starts the transfer of a domain to DNSimple.
#
# @see https://developer.dnsimple.com/v2/registrar/#transfer
# @see https://developer.dnsimple.com/v2/registrar/#transferDomain
#
# @example Initiate the transfer for example.com using the contact 1234 as registrant:
# client.registrar.transfer_domain(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
Expand Down Expand Up @@ -199,7 +199,7 @@ def cancel_domain_transfer(account_id, domain_name, domain_transfer_id, options

# Requests the transfer of a domain out of DNSimple.
#
# @see https://developer.dnsimple.com/v2/registrar/#transfer-out
# @see https://developer.dnsimple.com/v2/registrar/#authorizeDomainTransferOut
#
# @example Request to transfer of example.com out of DNSimple:
# client.registrar.transfer_domain_out(1010, "example.com")
Expand All @@ -219,7 +219,7 @@ def transfer_domain_out(account_id, domain_name, options = {})

# Restores a domain.
#
# @see https://developer.dnsimple.com/v2/registrar/#restore
# @see https://developer.dnsimple.com/v2/registrar/#restoreDomain
#
# @example Restore example.com:
# client.registrar.restore_domain(1010, "example.com", {})
Expand Down
8 changes: 4 additions & 4 deletions lib/dnsimple/client/registrar_delegation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module RegistrarDelegation
# Lists name servers the domain is delegating to.
#
# @see https://developer.dnsimple.com/v2/registrar/delegation/#list
# @see https://developer.dnsimple.com/v2/registrar/delegation/#getDomainDelegation
#
# @example List the name servers example.com is delegating to:
# client.registrar.domain_delegation(1010, "example.com")
Expand All @@ -25,7 +25,7 @@ def domain_delegation(account_id, domain_name, options = {})

# Chagne name servers the domain is delegating to.
#
# @see https://developer.dnsimple.com/v2/registrar/delegation/#update
# @see https://developer.dnsimple.com/v2/registrar/delegation/#changeDomainDelegation
#
# @example Change the name servers example.com is delegating to:
# client.registrar.change_domain_delegation(1010, "example.com",
Expand All @@ -47,7 +47,7 @@ def change_domain_delegation(account_id, domain_name, attributes, options = {})

# Enable vanity name servers for the domain.
#
# @see https://developer.dnsimple.com/v2/registrar/delegation/#delegateToVanity
# @see https://developer.dnsimple.com/v2/registrar/delegation/#changeDomainDelegationToVanity
#
# @example Enable vanity name servers for example.com:
# client.registrar.change_domain_delegation_to_vanity(1010, "example.com",
Expand All @@ -69,7 +69,7 @@ def change_domain_delegation_to_vanity(account_id, domain_name, attributes, opti

# Disable vanity name servers for the domain.
#
# @see https://developer.dnsimple.com/v2/registrar/delegation/#dedelegateFromVanity
# @see https://developer.dnsimple.com/v2/registrar/delegation/#changeDomainDelegationFromVanity
#
# @example Disable vanity name servers for example.com:
# client.registrar.change_domain_delegation_from_vanity(1010, "example.com")
Expand Down
4 changes: 2 additions & 2 deletions lib/dnsimple/client/registrar_transfer_lock.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def get_domain_transfer_lock(account_id, domain_name, options = {})

# Enable transfer lock for the domain in the account.
#
# @see https://developer.dnsimple.com/v2/registrar/#enableDomainTransferLock
# @see https://developer.dnsimple.com/v2/registrar/transfer-lock/#enableDomainTransferLock
#
# @param account_id [Integer] the account ID
# @param domain_name [#to_s] the domain name
Expand All @@ -40,7 +40,7 @@ def enable_domain_transfer_lock(account_id, domain_name, options = {})

# Disable trasnfer lock for the domain in the account.
#
# @see https://developer.dnsimple.com/v2/registrar/#disableDomainTransferLock
# @see https://developer.dnsimple.com/v2/registrar/transfer-lock/#disableDomainTransferLock
#
# @param account_id [Integer] the account ID
# @param domain_name [#to_s] the domain name
Expand Down
4 changes: 2 additions & 2 deletions lib/dnsimple/client/registrar_whois_privacy.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module RegistrarWhoisPrivacy
# Enables whois privacy for the domain.
#
# @see https://developer.dnsimple.com/v2/registrar/whois-privacy/#enable
# @see https://developer.dnsimple.com/v2/registrar/whois-privacy/#enableWhoisPrivacy
#
# @example Enable whois privacy for "example.com":
# client.registrar.enable_whois_privacy(1010, "example.com")
Expand All @@ -25,7 +25,7 @@ def enable_whois_privacy(account_id, domain_name, options = {})

# Disables whois privacy for the domain.
#
# @see https://developer.dnsimple.com/v2/registrar/whois-privacy/#disable
# @see https://developer.dnsimple.com/v2/registrar/whois-privacy/#disableWhoisPrivacy
#
# @example Disable whois privacy for "example.com":
# client.registrar.disable_whois_privacy(1010, "example.com")
Expand Down
6 changes: 3 additions & 3 deletions lib/dnsimple/client/services.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module Services
# Lists the available one-click services.
#
# @see https://developer.dnsimple.com/v2/services/#list
# @see https://developer.dnsimple.com/v2/services/#listServices
#
# @example List one-click services:
# client.services.list_services
Expand Down Expand Up @@ -42,7 +42,7 @@ def services(options = {})
# @example List all the one-click services:
# client.services.all_services
#
# @see https://developer.dnsimple.com/v2/services/#list
# @see https://developer.dnsimple.com/v2/services/#listServices
# @see #services
#
# @param options [Hash] the filtering and sorting options
Expand All @@ -58,7 +58,7 @@ def all_services(options = {})

# Gets the service with specified ID.
#
# @see https://developer.dnsimple.com/v2/services/#get
# @see https://developer.dnsimple.com/v2/services/#getService
#
# @example Get service 43:
# client.services.service(43)
Expand Down
6 changes: 3 additions & 3 deletions lib/dnsimple/client/services_domains.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Client
module ServicesDomains
# Lists the one-click services applied to the domain.
#
# @see https://developer.dnsimple.com/v2/services/domains/#applied
# @see https://developer.dnsimple.com/v2/services/domains/#listDomainAppliedServices
#
# @example List applied one-click services for example.com:
# client.service.applied_services(1010, "example.com")
Expand Down Expand Up @@ -34,7 +34,7 @@ def applied_services(account_id, domain_id, options = {})

# Apply a given one-click service to the domain.
#
# @see https://developer.dnsimple.com/v2/services/domains/#apply
# @see https://developer.dnsimple.com/v2/services/domains/#applyServiceToDomain
#
# @example Apply one-click service service1 to example.com:
# client.domain_services.applied_services(1010, "example.com", "service1")
Expand All @@ -59,7 +59,7 @@ def apply_service(account_id, service_id, domain_id, settings = {}, options = {}

# Unapply a given one-click service from the domain.
#
# @see https://developer.dnsimple.com/v2/services/domains/#unapply
# @see https://developer.dnsimple.com/v2/services/domains/#unapplyServiceFromDomain
#
# @example Unapply one-click service service1 from example.com:
# client.domain_services.applied_services(1010, "example.com", "service1")
Expand Down
Loading
Loading