foreman_api 0.1.6 → 0.1.7

data/lib/foreman_api/resources/ptable.rb

@@ -6,10 +6,10 @@ module ForemanApi
       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
+      # @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
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/puppetclass.rb

@@ -6,9 +6,13 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] environment_id Id of nested environment
-      # @option params [String] host_id Id of nested host
-      # @option params [String] hostgroup_id Id of nested hostgroup
+      # @option params [String] environment_id  id of nested environment 
+      # @option params [String] host_id  id of nested host 
+      # @option params [String] hostgroup_id  id of nested hostgroup 
+      # @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
       # @return [Array] First item: parsed data; second item: raw body
@@ -17,10 +21,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Id of puppetclass
-      # @option params [String] environment_id Id of nested environment
-      # @option params [String] host_id Id of nested host
-      # @option params [String] hostgroup_id Id of nested hostgroup
+      # @option params [String] id  id of puppetclass 
+      # @option params [String] environment_id  id of nested environment 
+      # @option params [String] host_id  id of nested host 
+      # @option params [String] hostgroup_id  id of nested hostgroup 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/report.rb

@@ -6,10 +6,10 @@ module ForemanApi
       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
+      # @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
       # @return [Array] First item: parsed data; second item: raw body
@@ -45,6 +45,21 @@ module ForemanApi
         perform_call(__method__, params, headers)
       end
 
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] report
+      #   allowed keys are:
+      #   * host [String]  hostname or certname 
+      #   * logs [Array]  optional array of log hashes 
+      #   * metrics [Hash]  hash of report metrics, can be just {} 
+      #   * reported_at [String]  utc time of report 
+      #   * status [Hash]  hash of status type totals 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
     end
   end
 end

data/lib/foreman_api/resources/role.rb

@@ -6,8 +6,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
+      # @option params [String] page  paginate results 
+      # @option params [String] per_page  number of entries per request 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/setting.rb

@@ -6,10 +6,10 @@ module ForemanApi
       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
+      # @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
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/smart_class_parameter.rb

@@ -0,0 +1,55 @@
+module ForemanApi
+  module Resources
+    class SmartClassParameter < ForemanApi::Base
+      def self.doc
+        @doc ||= ForemanApi.doc['resources']["smart_class_parameters"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] environment_id
+      # @option params [String] host_id
+      # @option params [String] hostgroup_id
+      # @option params [String] puppetclass_id
+      # @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
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, 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
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id
+      # @option params [Hash] smart_class_parameter
+      #   allowed keys are:
+      #   * default_value [String]
+      #   * description [String]
+      #   * override [String]
+      #   * override_value_order [String]
+      #   * parameter_type [String]
+      #   * path [String]
+      #   * required [String]
+      #   * validator_rule [String]
+      #   * validator_type [String]
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/smart_proxy.rb

@@ -6,9 +6,21 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] type Filter by type
+      # @option params [Object] id Part of +/api/smart_proxies/:id/import_puppetclasses+ path
+      # @option params [String] environment_id
+      # @option params [String] smart_proxy_id
+      # @option params [String] dryrun
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def import_puppetclasses(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] page  paginate results 
+      # @option params [String] per_page  number of entries per request 
+      # @option params [String] type  filter by type 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -59,6 +71,15 @@ module ForemanApi
         perform_call(__method__, 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
+      # @return [Array] First item: parsed data; second item: raw body
+      def refresh(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
     end
   end
 end

data/lib/foreman_api/resources/smart_variable.rb

@@ -0,0 +1,80 @@
+module ForemanApi
+  module Resources
+    class SmartVariable < ForemanApi::Base
+      def self.doc
+        @doc ||= ForemanApi.doc['resources']["smart_variables"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] host_id
+      # @option params [String] hostgroup_id
+      # @option params [String] puppetclass_id
+      # @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
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, 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
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] smart_variable
+      #   allowed keys are:
+      #   * puppetclass_id [String]
+      #   * default_value [String]
+      #   * description [String]
+      #   * override_value_order [String]
+      #   * validator_rule [String]
+      #   * validator_type [String]
+      #   * variable [String]
+      #   * variable_type [String]
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id
+      # @option params [Hash] smart_variable
+      #   allowed keys are:
+      #   * puppetclass_id [String]
+      #   * default_value [String]
+      #   * description [String]
+      #   * override_value_order [String]
+      #   * validator_rule [String]
+      #   * validator_type [String]
+      #   * variable [String]
+      #   * variable_type [String]
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, 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
+      # @return [Array] First item: parsed data; second item: raw body
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/statistic.rb

@@ -0,0 +1,18 @@
+module ForemanApi
+  module Resources
+    class Statistic < ForemanApi::Base
+      def self.doc
+        @doc ||= ForemanApi.doc['resources']["statistics"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/subnet.rb

@@ -6,10 +6,10 @@ module ForemanApi
       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
+      # @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
       # @return [Array] First item: parsed data; second item: raw body
@@ -29,19 +29,19 @@ module ForemanApi
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Hash] subnet
       #   allowed keys are:
-      #   * dhcp_id [String] Dhcp proxy to use within this subnet
-      #   * dns_id [String] Dns proxy to use within this subnet
-      #   * domain_ids [Array] Domains in which this subnet is part
-      #   * tftp_id [String] Tftp proxy to use within this subnet
-      #   * dns_primary [String] Primary dns for this subnet
-      #   * dns_secondary [String] Secondary dns for this subnet
-      #   * from [String] Starting ip address for ip auto suggestion
-      #   * gateway [String] Primary dns for this subnet
-      #   * mask [String] Netmask for this subnet
-      #   * name [String] Subnet name
-      #   * network [String] Subnet network
-      #   * to [String] Ending ip address for ip auto suggestion
-      #   * vlanid [String] Vlan id for this subnet
+      #   * dhcp_id [String]  dhcp proxy to use within this subnet 
+      #   * dns_id [String]  dns proxy to use within this subnet 
+      #   * domain_ids [Array]  domains in which this subnet is part 
+      #   * tftp_id [String]  tftp proxy to use within this subnet 
+      #   * dns_primary [String]  primary dns for this subnet 
+      #   * dns_secondary [String]  secondary dns for this subnet 
+      #   * from [String]  starting ip address for ip auto suggestion 
+      #   * gateway [String]  primary dns for this subnet 
+      #   * mask [String]  netmask for this subnet 
+      #   * name [String]  subnet name 
+      #   * network [String]  subnet network 
+      #   * to [String]  ending ip address for ip auto suggestion 
+      #   * vlanid [String]  vlan id for this subnet 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -50,22 +50,22 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Subnet numeric identifier
+      # @option params [String] id  subnet numeric identifier 
       # @option params [Hash] subnet
       #   allowed keys are:
-      #   * dhcp_id [String, nil] Dhcp proxy to use within this subnet
-      #   * dns_id [String, nil] Dns proxy to use within this subnet
-      #   * domain_ids [Array, nil] Domains in which this subnet is part
-      #   * tftp_id [String, nil] Tftp proxy to use within this subnet
-      #   * dns_primary [String, nil] Primary dns for this subnet
-      #   * dns_secondary [String, nil] Secondary dns for this subnet
-      #   * from [String, nil] Starting ip address for ip auto suggestion
-      #   * gateway [String, nil] Primary dns for this subnet
-      #   * mask [String] Netmask for this subnet
-      #   * name [String] Subnet name
-      #   * network [String] Subnet network
-      #   * to [String, nil] Ending ip address for ip auto suggestion
-      #   * vlanid [String, nil] Vlan id for this subnet
+      #   * dhcp_id [String, nil]  dhcp proxy to use within this subnet 
+      #   * dns_id [String, nil]  dns proxy to use within this subnet 
+      #   * domain_ids [Array, nil]  domains in which this subnet is part 
+      #   * tftp_id [String, nil]  tftp proxy to use within this subnet 
+      #   * dns_primary [String, nil]  primary dns for this subnet 
+      #   * dns_secondary [String, nil]  secondary dns for this subnet 
+      #   * from [String, nil]  starting ip address for ip auto suggestion 
+      #   * gateway [String, nil]  primary dns for this subnet 
+      #   * mask [String]  netmask for this subnet 
+      #   * name [String]  subnet name 
+      #   * network [String]  subnet network 
+      #   * to [String, nil]  ending ip address for ip auto suggestion 
+      #   * vlanid [String, nil]  vlan id for this subnet 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -74,7 +74,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Subnet numeric identifier
+      # @option params [String] id  subnet numeric identifier 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/template_combination.rb

@@ -18,8 +18,8 @@ module ForemanApi
       # @option params [String] config_template_id
       # @option params [Hash] template_combination
       #   allowed keys are:
-      #   * environment_id [String, nil] Environment id
-      #   * hostgroup_id [String, nil] Hostgroup id
+      #   * environment_id [String, nil]  environment id 
+      #   * hostgroup_id [String, nil]  hostgroup id 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/template_kind.rb

@@ -6,8 +6,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
+      # @option params [String] page  paginate results 
+      # @option params [String] per_page  number of entries per request 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/user.rb

@@ -6,10 +6,10 @@ module ForemanApi
       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
+      # @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
       # @return [Array] First item: parsed data; second item: raw body
@@ -30,7 +30,7 @@ module ForemanApi
       # @option params [Hash] user
       #   allowed keys are:
       #   * auth_source_id [Numeric]
-      #   * admin [String] Is an admin account?
+      #   * admin [String]  is an admin account? 
       #   * firstname [String]
       #   * lastname [String]
       #   * login [String]
@@ -47,7 +47,7 @@ module ForemanApi
       # @option params [String] id
       # @option params [Hash] user
       #   allowed keys are:
-      #   * admin [String] Is an admin account?
+      #   * admin [String]  is an admin account? 
       #   * firstname [String, nil]
       #   * lastname [String, nil]
       #   * login [String]