module ForemanApi
  module Resources
    class Domain < ForemanApi::Base
      def self.doc
        @doc ||= ForemanApi.doc['resources']["domains"]
      end
      
      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] order Sort results 
      # @option params [String] page Paginate results 
      # @option params [String] per_page Number of entries per request 
      # @option params [String] search Filter results 
      #
      # @param [Hash] headers additional http headers
      def index(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/domains", params
        call(:"get", url, params, headers)
      end

      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] id May be numerical id or domain name 
      #
      # @param [Hash] headers additional http headers
      def show(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/domains/:id", params
        call(:"get", url, params, headers)
      end

      # @param [Hash] params a hash of params to be passed to the service
      # @option params [Hash] domain 
      #   allowed keys are: 
      #   * dns_id [String, nil] Dns proxy to use within this domain ,
      #   * domain_parameters_attributes [String] Array of parameters (name, value) ,
      #   * fullname [String, nil] Full name describing the domain ,
      #   * name [String] The full dns domain name ,
      #
      # @param [Hash] headers additional http headers
      def create(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/domains", params
        call(:"post", url, params, headers)
      end

      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] id 
      # @option params [Hash] domain 
      #   allowed keys are: 
      #   * dns_id [String, nil] Dns proxy to use within this domain ,
      #   * domain_parameters_attributes [String] Array of parameters (name, value) ,
      #   * fullname [String, nil] Full name describing the domain ,
      #   * name [String, nil] The full dns domain name ,
      #
      # @param [Hash] headers additional http headers
      def update(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/domains/:id", params
        call(:"put", url, params, headers)
      end

      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] id 
      #
      # @param [Hash] headers additional http headers
      def destroy(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/domains/:id", params
        call(:"delete", url, params, headers)
      end

    end
  end
end