class IronWorker::GroupsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/iron_ruby/api/groups_api.rb, line 30
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

groups_get(opts = {}) click to toggle source

Get all group names. Get a list of all the groups in the system. @param [Hash] opts the optional parameters @return [GroupsWrapper]

# File lib/iron_ruby/api/groups_api.rb, line 38
def groups_get(opts = {})
  data, _status_code, _headers = groups_get_with_http_info(opts)
  return data
end
groups_get_with_http_info(opts = {}) click to toggle source

Get all group names. Get a list of all the groups in the system. @param [Hash] opts the optional parameters @return [Array<(GroupsWrapper, Fixnum, Hash)>] GroupsWrapper data, response status code and response headers

# File lib/iron_ruby/api/groups_api.rb, line 47
def groups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_get ..."
  end
  # resource path
  local_var_path = "/groups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupsWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
groups_name_get(name, opts = {}) click to toggle source

Get information for a group. This gives more details about a task group, such as statistics. @param name name of the group. @param [Hash] opts the optional parameters @return [GroupWrapper]

# File lib/iron_ruby/api/groups_api.rb, line 92
def groups_name_get(name, opts = {})
  data, _status_code, _headers = groups_name_get_with_http_info(name, opts)
  return data
end
groups_name_get_with_http_info(name, opts = {}) click to toggle source

Get information for a group. This gives more details about a task group, such as statistics. @param name name of the group. @param [Hash] opts the optional parameters @return [Array<(GroupWrapper, Fixnum, Hash)>] GroupWrapper data, response status code and response headers

# File lib/iron_ruby/api/groups_api.rb, line 102
def groups_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_name_get ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling GroupsApi.groups_name_get" if name.nil?
  # resource path
  local_var_path = "/groups/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
groups_name_put(name, body, opts = {}) click to toggle source

Create/update a task group. You can set group level settings here. @param name name of the group. @param body Group to post. @param [Hash] opts the optional parameters @return [GroupWrapper]

# File lib/iron_ruby/api/groups_api.rb, line 150
def groups_name_put(name, body, opts = {})
  data, _status_code, _headers = groups_name_put_with_http_info(name, body, opts)
  return data
end
groups_name_put_with_http_info(name, body, opts = {}) click to toggle source

Create/update a task group. You can set group level settings here. @param name name of the group. @param body Group to post. @param [Hash] opts the optional parameters @return [Array<(GroupWrapper, Fixnum, Hash)>] GroupWrapper data, response status code and response headers

# File lib/iron_ruby/api/groups_api.rb, line 161
def groups_name_put_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_name_put ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling GroupsApi.groups_name_put" if name.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.groups_name_put" if body.nil?
  # resource path
  local_var_path = "/groups/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
groups_post(body, opts = {}) click to toggle source

Post new group Insert a new task group @param body Group to post. @param [Hash] opts the optional parameters @return [GroupWrapper]

# File lib/iron_ruby/api/groups_api.rb, line 210
def groups_post(body, opts = {})
  data, _status_code, _headers = groups_post_with_http_info(body, opts)
  return data
end
groups_post_with_http_info(body, opts = {}) click to toggle source

Post new group Insert a new task group @param body Group to post. @param [Hash] opts the optional parameters @return [Array<(GroupWrapper, Fixnum, Hash)>] GroupWrapper data, response status code and response headers

# File lib/iron_ruby/api/groups_api.rb, line 220
def groups_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_post ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.groups_post" if body.nil?
  # resource path
  local_var_path = "/groups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end