dnsimple 3.1.0 → 4.0.0

data/lib/dnsimple/client/domains_pushes.rb

@@ -0,0 +1,97 @@
+module Dnsimple
+  class Client
+    module DomainsPushes
+
+      # Initiate a push for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/pushes/#initiate
+      #
+      # @example Initiate a domain pushe for example.com:
+      #   client.domains.initiate_push(1010, "example.com", new_account_email: "admin@target-account.test")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id The domain ID or domain name
+      # @param  [Hash] attributes
+      # @option attributes [String] :new_account_email the target account email (mandatory)
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::DomainPush>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def initiate_push(account_id, domain_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:new_account_email])
+        response = client.post(Client.versioned("/%s/domains/%s/pushes" % [account_id, domain_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::DomainPush.new(response["data"]))
+      end
+
+      # Lists the pushes for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/pushes/#list
+      #
+      # @example List domain pushes in the first page
+      #   client.domains.pushes(2020)
+      #
+      # @example List domain pushes, provide a specific page
+      #   client.domains.pushes(2020, page: 2)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [Hash] options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::DomainPush>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def pushes(account_id, options = {})
+        response = client.get(Client.versioned("/%s/pushes" % [account_id]), Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::DomainPush.new(r) })
+      end
+
+      # Accept a domain push.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/pushes/#accept
+      #
+      # @example Accept a domain push in the target account:
+      #   client.domains.accept_push(2020, 1, contact_id: 2)
+      #
+      # @param  [Fixnum] account_id the target account ID
+      # @param  [Fixnum] push_id the domain push ID
+      # @param  [Hash] options
+      # @param  [Hash] attributes
+      # @option attributes [Integer] :contact_id the contact ID (mandatory)
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def accept_push(account_id, push_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:contact_id])
+        response = client.post(Client.versioned("/%s/pushes/%s" % [account_id, push_id]), attributes, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+      # Reject a domain push.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/pushes/#reject
+      #
+      # @example Reject a domain push in the target account:
+      #   client.domains.reject_push(2020, 1, contact_id: 2)
+      #
+      # @param  [Fixnum] account_id the target account ID
+      # @param  [Fixnum] push_id the domain push ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def reject_push(account_id, push_id, options = {})
+        response = client.delete(Client.versioned("/%s/pushes/%s" % [account_id, push_id]), options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+    end
+
+  end
+end

data/lib/dnsimple/client/registrar.rb

@@ -71,7 +71,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#transfer
       #
       # @example Initiate the transfer for example.com using the contact 1234 as registrant:
-      #   client.registrar.transfer(1010, "example.com", registrant_id: 1234, auth_info: "x1y2z3")
+      #   client.registrar.transfer(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
       #
       # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer
@@ -90,7 +90,7 @@ module Dnsimple
 
       # 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/#transfer-out
       #
       # @example Request to transfer of example.com out of DNSimple:
       #   client.registrar.transfer_out(1010, "example.com")

data/lib/dnsimple/client/registrar_delegation.rb

@@ -44,6 +44,48 @@ module Dnsimple
         Dnsimple::Response.new(response, response["data"])
       end
 
+      # Enable vanity name servers for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/delegation/#delegateToVanity
+      #
+      # @example Enable vanity name servers for example.com:
+      #   client.registrar.change_domain_delegation_to_vanity(1010, "example.com",
+      #       ["ns1.example.com", "ns2.example.com", "ns3.example.com", "ns4.example.com"])
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_name the domain name to check
+      # @param  [Array] attributes
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Array>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def change_domain_delegation_to_vanity(account_id, domain_name, attributes, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/delegation/vanity" % [account_id, domain_name])
+        response = client.put(endpoint, attributes, options)
+
+        Dnsimple::Response.new(response, response["data"])
+      end
+
+      # Disable vanity name servers for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/delegation/#delegateFromVanity
+      #
+      # @example Disable vanity name servers for example.com:
+      #   client.registrar.change_domain_delegation_from_vanity(1010, "example.com")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_name the domain name to check
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def change_domain_delegation_from_vanity(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/delegation/vanity" % [account_id, domain_name])
+        response = client.delete(endpoint, options)
+
+        Dnsimple::Response.new(response, response["data"])
+      end
+
     end
   end
 end

data/lib/dnsimple/client/services_domains.rb

@@ -0,0 +1,82 @@
+module Dnsimple
+  class Client
+    module ServicesDomains
+
+      # Lists the one-click services applied to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/services/domains/#applied
+      #
+      # @example List applied one-click services for example.com:
+      #   client.service.applied_services(1010, "example.com")
+      #
+      # @example List applied one-click services for example.com, provide a specific page:
+      #   client.services.applied_services(1010, "example.com", page: 2)
+      #
+      # @example List applied one-click services for example.com, provide a sorting policy:
+      #   client.services.applied_services(1010, "example.com", sort: "short_name:asc")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain name
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Service>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def applied_services(account_id, domain_id, options = {})
+        endpoint = Client.versioned("/%s/domains/%s/services" % [account_id, domain_id])
+        response = client.get(endpoint, Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Service.new(r) })
+      end
+
+      # Apply a given one-click service to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/services/domains/#apply
+      #
+      # @example Apply one-click service service1 to example.com:
+      #   client.domain_services.applied_services(1010, "example.com", "service1")
+      #
+      # @example Apply one-click service service1 to example.com, provide optional settings:
+      #   client.domain_services.applied_services(1010, "example.com", "service1", app: "foo")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] service_id the service name (or ID)
+      # @param  [#to_s] domain_id the domain name
+      # @param  [Hash] settings optional settings to apply the one-click service
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def apply_service(account_id, service_id, domain_id, settings = {}, options = {})
+        endpoint = Client.versioned("/%s/domains/%s/services/%s" % [account_id, domain_id, service_id])
+        response = client.post(endpoint, settings, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+      # Unapply a given one-click service from the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/services/domains/#unapply
+      #
+      # @example Unapply one-click service service1 from example.com:
+      #   client.domain_services.applied_services(1010, "example.com", "service1")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] service_id the service name (or ID)
+      # @param  [#to_s] domain_id the domain name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def unapply_service(account_id, service_id, domain_id, options = {})
+        endpoint = Client.versioned("/%s/domains/%s/services/%s" % [account_id, domain_id, service_id])
+        response = client.delete(endpoint, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/templates.rb

@@ -29,7 +29,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Template.new(r) })
       end
-      alias list templates
       alias list_templates templates
 
       # Lists ALL the templates in the account.
@@ -57,7 +56,6 @@ module Dnsimple
       def all_templates(account_id, options = {})
         paginate(:templates, account_id, options)
       end
-      alias all all_templates
 
       # Creates a template in the account.
       #
@@ -78,7 +76,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Template.new(response["data"]))
       end
-      alias create create_template
 
       # Gets the template with specified ID.
       #
@@ -120,7 +117,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Template.new(response["data"]))
       end
-      alias update update_template
 
       # Deletes a template from the account.
       #
@@ -144,7 +140,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_template
 
     end
   end

data/lib/dnsimple/client/templates_domains.rb

@@ -0,0 +1,29 @@
+module Dnsimple
+  class Client
+    module TemplatesDomains
+
+      # Applies a template to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/templates/domains/#apply
+      #
+      # @example Apply template 5401 for example.com in account 1010:
+      #   client.templates.apply_template(1010, 5401, "example.com")
+      #
+      # @param  [Fixnum] account_id The account ID
+      # @param  [#to_s] template_id The template ID
+      # @param  [#to_s] domain_id The Domain ID or name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def apply_template(account_id, template_id, domain_id, options = {})
+        endpoint = Client.versioned("/%s/domains/%s/templates/%s" % [account_id, domain_id, template_id])
+        response = client.post(endpoint, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/vanity_name_servers.rb

@@ -0,0 +1,47 @@
+module Dnsimple
+  class Client
+    module VanityNameServers
+
+      # Enable vanity name servers for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/vanity/#enable
+      #
+      # @example Enable vanity name servers for example.com:
+      #   client.vanity_name_servers.enable(1010, "example.com")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Array>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def enable_vanity_name_servers(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/vanity/%s" % [account_id, domain_name])
+        response = client.put(endpoint, options)
+
+        Dnsimple::Response.new(response, response["data"])
+      end
+
+      # Disable vanity name servers for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/vanity/#disable
+      #
+      # @example Disable vanity name servers for example.com:
+      #   client.vanity_name_servers.disable(1010, "example.com")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [RequestError] When the request fails.
+      def disable_vanity_name_servers(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/vanity/%s" % [account_id, domain_name])
+        response = client.delete(endpoint, options)
+
+        Dnsimple::Response.new(response, response["data"])
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/zones.rb

@@ -77,6 +77,23 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::Zone.new(response["data"]))
       end
 
+      # Gets a zone file from the account.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/#get-file
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] zone_name the zone name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneFile>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def zone_file(account_id, zone_name, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/file" % [account_id, zone_name]), options)
+
+        Dnsimple::Response.new(response, Struct::ZoneFile.new(response["data"]))
+      end
+
     end
   end
 end

data/lib/dnsimple/client/zones_records.rb

@@ -26,14 +26,14 @@ module Dnsimple
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @option options [String] :sort sorting policy
       # @option options [Hash] :filter filtering policy
-      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Record>]
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def records(account_id, zone_id, options = {})
         response = client.get(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), Options::ListOptions.new(options))
 
-        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Record.new(r) })
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::ZoneRecord.new(r) })
       end
       alias list records
       alias list_records records
@@ -59,7 +59,7 @@ module Dnsimple
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @option options [String] :sort sorting policy
       # @option options [Hash] :filter filtering policy
-      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Record>]
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
@@ -79,7 +79,7 @@ module Dnsimple
       # @param  [String] zone_id the zone name
       # @param  [Hash] attributes
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
@@ -87,7 +87,7 @@ module Dnsimple
         Extra.validate_mandatory_attributes(attributes, [:type, :name, :content])
         response = client.post(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), attributes, options)
 
-        Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
+        Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
       alias create create_record
 
@@ -102,14 +102,14 @@ module Dnsimple
       # @param  [String] zone_id the zone name
       # @param  [Fixnum] record_id the record ID
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def record(account_id, zone_id, record_id, options = {})
         response = client.get(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), options)
 
-        Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
+        Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
 
       # Updates a zone record in the account.
@@ -124,14 +124,14 @@ module Dnsimple
       # @param  [Fixnum] record_id the record ID
       # @param  [Hash] attributes
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def update_record(account_id, zone_id, record_id, attributes, options = {})
         response = client.patch(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), attributes, options)
 
-        Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
+        Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
       alias update update_record