module Dnsimple
  class Client
    module Registrar

      # Checks whether a domain is available to be registered.
      #
      # @see https://developer.dnsimple.com/v2/registrar/#check
      #
      # @example Check whether example.com is available:
      #   client.registrar.check(1010, "example.com")
      #
      # @param  [Fixnum] account_id the account ID
      # @param  [#to_s] domain_name the domain name to check
      # @param  [Hash] options
      # @return [Struct::DomainCheck]
      #
      # @raise  [RequestError] When the request fails.
      def check_domain(account_id, domain_name, options = {})
        endpoint = Client.versioned("/%s/registrar/domains/%s/check" % [account_id, domain_name])
        response = client.get(endpoint, options)

        Dnsimple::Response.new(response, Struct::DomainCheck.new(response["data"]))
      end

      # Registers a domain.
      #
      # @see https://developer.dnsimple.com/v2/registrar/#register
      #
      # @example Initiate the registration of example.com using the contact 1234 as registrant
      #   including WHOIS privacy for the domain and enabling auto renewal:
      #   client.registrar.register(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
      #
      # @param  [Fixnum] account_id the account ID
      # @param  [#to_s] domain_name the domain name to register
      # @param  [Hash] attributes
      # @param  [Hash] options
      # @return [Struct::Domain]
      #
      # @raise  [RequestError] When the request fails.
      def register_domain(account_id, domain_name, attributes, options = {})
        Extra.validate_mandatory_attributes(attributes, [:registrant_id])
        endpoint = Client.versioned("/%s/registrar/domains/%s/registration" % [account_id, domain_name])
        response = client.post(endpoint, attributes, options)

        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
      end

      # Renews a domain.
      #
      # @see https://developer.dnsimple.com/v2/registrar/#renew
      #
      # @example Renew example.com for 3 years:
      #   client.registrar.renew(1010, "example.com", period: 3)
      #
      # @param  [Fixnum] account_id the account ID
      # @param  [#to_s] domain_name the domain name to renew
      # @param  [Hash] attributes
      # @param  [Hash] options
      # @return [Struct::Domain]
      #
      # @raise  [RequestError] When the request fails.
      def renew_domain(account_id, domain_name, attributes = nil, options = {})
        endpoint = Client.versioned("/%s/registrar/domains/%s/renewal" % [account_id, domain_name])
        response = client.post(endpoint, attributes, options)

        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
      end

      # Starts the transfer of a domain to 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_code: "x1y2z3")
      #
      # @param  [Fixnum] account_id the account ID
      # @param  [#to_s] domain_name the domain name to transfer
      # @param  [Hash] attributes
      # @param  [Hash] options
      # @return [Struct::Domain]
      #
      # @raise  [RequestError] When the request fails.
      def transfer_domain(account_id, domain_name, attributes, options = {})
        Extra.validate_mandatory_attributes(attributes, [:registrant_id])
        endpoint = Client.versioned("/%s/registrar/domains/%s/transfer" % [account_id, domain_name])
        response = client.post(endpoint, attributes, options)

        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
      end

      # Requests the transfer of a domain out of DNSimple.
      #
      # @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")
      #
      # @param  [Fixnum] account_id the account ID
      # @param  [#to_s] domain_name the domain name to transfer out
      # @param  [Hash] options
      # @return [Dnsimple::Response<nil>]
      #
      # @raise  [RequestError] When the request fails.
      def transfer_domain_out(account_id, domain_name, options = {})
        endpoint = Client.versioned("/%s/registrar/domains/%s/transfer_out" % [account_id, domain_name])
        response = client.post(endpoint, nil, options)

        Dnsimple::Response.new(response, nil)
      end
    end
  end
end