class Nodeum::UsersApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create_api_key(api_key_body, opts = {}) click to toggle source

Creates a new API Key for current user. **API Key Scope**: api_keys / create @param api_key_body [ApiKeyFull] @param [Hash] opts the optional parameters @return [ApiKeyFull]

# File lib/nodeum_sdk/api/users_api.rb, line 27
def create_api_key(api_key_body, opts = {})
  data, _status_code, _headers = create_api_key_with_http_info(api_key_body, opts)
  data
end
create_api_key_with_http_info(api_key_body, opts = {}) click to toggle source

Creates a new API Key for current user. **API Key Scope**: api_keys / create @param api_key_body [ApiKeyFull] @param [Hash] opts the optional parameters @return [Array<(ApiKeyFull, Integer, Hash)>] ApiKeyFull data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 37
def create_api_key_with_http_info(api_key_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.create_api_key ...'
  end
  # verify the required parameter 'api_key_body' is set
  if @api_client.config.client_side_validation && api_key_body.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_body' when calling UsersApi.create_api_key"
  end
  # resource path
  local_var_path = '/users/me/api_keys'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(api_key_body) 

  # return_type
  return_type = opts[:return_type] || 'ApiKeyFull' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_configuration(configuration_body, opts = {}) click to toggle source

Creates a new configuration value for current user. **API Key Scope**: configurations / create @param configuration_body [UserConfiguration] @param [Hash] opts the optional parameters @return [UserConfiguration]

# File lib/nodeum_sdk/api/users_api.rb, line 91
def create_configuration(configuration_body, opts = {})
  data, _status_code, _headers = create_configuration_with_http_info(configuration_body, opts)
  data
end
create_configuration_with_http_info(configuration_body, opts = {}) click to toggle source

Creates a new configuration value for current user. **API Key Scope**: configurations / create @param configuration_body [UserConfiguration] @param [Hash] opts the optional parameters @return [Array<(UserConfiguration, Integer, Hash)>] UserConfiguration data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 101
def create_configuration_with_http_info(configuration_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.create_configuration ...'
  end
  # verify the required parameter 'configuration_body' is set
  if @api_client.config.client_side_validation && configuration_body.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_body' when calling UsersApi.create_configuration"
  end
  # resource path
  local_var_path = '/users/me/configurations'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(configuration_body) 

  # return_type
  return_type = opts[:return_type] || 'UserConfiguration' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#create_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
destroy_api_key(api_key_id, opts = {}) click to toggle source

Destroys a specific API Key. **API Key Scope**: api_keys / destroy @param api_key_id [Integer] Numeric ID of API Key. @param [Hash] opts the optional parameters @return [nil]

# File lib/nodeum_sdk/api/users_api.rb, line 155
def destroy_api_key(api_key_id, opts = {})
  destroy_api_key_with_http_info(api_key_id, opts)
  nil
end
destroy_api_key_with_http_info(api_key_id, opts = {}) click to toggle source

Destroys a specific API Key. **API Key Scope**: api_keys / destroy @param api_key_id [Integer] Numeric ID of API Key. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 165
def destroy_api_key_with_http_info(api_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.destroy_api_key ...'
  end
  # verify the required parameter 'api_key_id' is set
  if @api_client.config.client_side_validation && api_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_id' when calling UsersApi.destroy_api_key"
  end
  # resource path
  local_var_path = '/users/me/api_keys/{api_key_id}'.sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#destroy_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
destroy_configuration(configuration_id, opts = {}) click to toggle source

Destroys a specific configuration value. **API Key Scope**: configurations / destroy @param configuration_id [String] Numeric ID, or key of configuration. @param [Hash] opts the optional parameters @return [nil]

# File lib/nodeum_sdk/api/users_api.rb, line 215
def destroy_configuration(configuration_id, opts = {})
  destroy_configuration_with_http_info(configuration_id, opts)
  nil
end
destroy_configuration_with_http_info(configuration_id, opts = {}) click to toggle source

Destroys a specific configuration value. **API Key Scope**: configurations / destroy @param configuration_id [String] Numeric ID, or key of configuration. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 225
def destroy_configuration_with_http_info(configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.destroy_configuration ...'
  end
  # verify the required parameter 'configuration_id' is set
  if @api_client.config.client_side_validation && configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_id' when calling UsersApi.destroy_configuration"
  end
  # resource path
  local_var_path = '/users/me/configurations/{configuration_id}'.sub('{' + 'configuration_id' + '}', CGI.escape(configuration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#destroy_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_api_keys(opts = {}) click to toggle source

Lists all API keys of current user. **API Key Scope**: api_keys / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @return [ApiKeyCollection]

# File lib/nodeum_sdk/api/users_api.rb, line 276
def index_api_keys(opts = {})
  data, _status_code, _headers = index_api_keys_with_http_info(opts)
  data
end
index_api_keys_with_http_info(opts = {}) click to toggle source

Lists all API keys of current user. **API Key Scope**: api_keys / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @return [Array<(ApiKeyCollection, Integer, Hash)>] ApiKeyCollection data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 287
def index_api_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.index_api_keys ...'
  end
  # resource path
  local_var_path = '/users/me/api_keys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApiKeyCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#index_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_configurations(opts = {}) click to toggle source

Lists all configurations of current user. **API Key Scope**: configurations / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @return [UserConfigurationCollection]

# File lib/nodeum_sdk/api/users_api.rb, line 338
def index_configurations(opts = {})
  data, _status_code, _headers = index_configurations_with_http_info(opts)
  data
end
index_configurations_with_http_info(opts = {}) click to toggle source

Lists all configurations of current user. **API Key Scope**: configurations / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @return [Array<(UserConfigurationCollection, Integer, Hash)>] UserConfigurationCollection data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 349
def index_configurations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.index_configurations ...'
  end
  # resource path
  local_var_path = '/users/me/configurations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'UserConfigurationCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#index_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_system_groups(opts = {}) click to toggle source

List all system groups. **API Key Scope**: groups / systems @param [Hash] opts the optional parameters @return [SystemGroupCollection]

# File lib/nodeum_sdk/api/users_api.rb, line 398
def index_system_groups(opts = {})
  data, _status_code, _headers = index_system_groups_with_http_info(opts)
  data
end
index_system_groups_with_http_info(opts = {}) click to toggle source

List all system groups. **API Key Scope**: groups / systems @param [Hash] opts the optional parameters @return [Array<(SystemGroupCollection, Integer, Hash)>] SystemGroupCollection data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 407
def index_system_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.index_system_groups ...'
  end
  # resource path
  local_var_path = '/groups/-/systems'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'SystemGroupCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#index_system_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_system_users(opts = {}) click to toggle source

List all system users. **API Key Scope**: users / systems @param [Hash] opts the optional parameters @return [SystemUserCollection]

# File lib/nodeum_sdk/api/users_api.rb, line 454
def index_system_users(opts = {})
  data, _status_code, _headers = index_system_users_with_http_info(opts)
  data
end
index_system_users_with_http_info(opts = {}) click to toggle source

List all system users. **API Key Scope**: users / systems @param [Hash] opts the optional parameters @return [Array<(SystemUserCollection, Integer, Hash)>] SystemUserCollection data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 463
def index_system_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.index_system_users ...'
  end
  # resource path
  local_var_path = '/users/-/systems'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'SystemUserCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#index_system_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
show_api_key(api_key_id, opts = {}) click to toggle source

Displays a specific API Key with its scopes. **API Key Scope**: api_keys / show @param api_key_id [Integer] Numeric ID of API Key. @param [Hash] opts the optional parameters @return [ApiKeyFull]

# File lib/nodeum_sdk/api/users_api.rb, line 511
def show_api_key(api_key_id, opts = {})
  data, _status_code, _headers = show_api_key_with_http_info(api_key_id, opts)
  data
end
show_api_key_with_http_info(api_key_id, opts = {}) click to toggle source

Displays a specific API Key with its scopes. **API Key Scope**: api_keys / show @param api_key_id [Integer] Numeric ID of API Key. @param [Hash] opts the optional parameters @return [Array<(ApiKeyFull, Integer, Hash)>] ApiKeyFull data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 521
def show_api_key_with_http_info(api_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.show_api_key ...'
  end
  # verify the required parameter 'api_key_id' is set
  if @api_client.config.client_side_validation && api_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_id' when calling UsersApi.show_api_key"
  end
  # resource path
  local_var_path = '/users/me/api_keys/{api_key_id}'.sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApiKeyFull' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#show_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
show_configuration(configuration_id, opts = {}) click to toggle source

Displays a specific configuration value. **API Key Scope**: configurations / show @param configuration_id [String] Numeric ID, or key of configuration. @param [Hash] opts the optional parameters @return [UserConfiguration]

# File lib/nodeum_sdk/api/users_api.rb, line 573
def show_configuration(configuration_id, opts = {})
  data, _status_code, _headers = show_configuration_with_http_info(configuration_id, opts)
  data
end
show_configuration_with_http_info(configuration_id, opts = {}) click to toggle source

Displays a specific configuration value. **API Key Scope**: configurations / show @param configuration_id [String] Numeric ID, or key of configuration. @param [Hash] opts the optional parameters @return [Array<(UserConfiguration, Integer, Hash)>] UserConfiguration data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 583
def show_configuration_with_http_info(configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.show_configuration ...'
  end
  # verify the required parameter 'configuration_id' is set
  if @api_client.config.client_side_validation && configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_id' when calling UsersApi.show_configuration"
  end
  # resource path
  local_var_path = '/users/me/configurations/{configuration_id}'.sub('{' + 'configuration_id' + '}', CGI.escape(configuration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'UserConfiguration' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#show_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_api_key(api_key_id, api_key_body, opts = {}) click to toggle source

Updates a specific API Key. **API Key Scope**: api_keys / update @param api_key_id [Integer] Numeric ID of API Key. @param api_key_body [ApiKeyFull] @param [Hash] opts the optional parameters @return [ApiKeyFull]

# File lib/nodeum_sdk/api/users_api.rb, line 636
def update_api_key(api_key_id, api_key_body, opts = {})
  data, _status_code, _headers = update_api_key_with_http_info(api_key_id, api_key_body, opts)
  data
end
update_api_key_with_http_info(api_key_id, api_key_body, opts = {}) click to toggle source

Updates a specific API Key. **API Key Scope**: api_keys / update @param api_key_id [Integer] Numeric ID of API Key. @param api_key_body [ApiKeyFull] @param [Hash] opts the optional parameters @return [Array<(ApiKeyFull, Integer, Hash)>] ApiKeyFull data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 647
def update_api_key_with_http_info(api_key_id, api_key_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.update_api_key ...'
  end
  # verify the required parameter 'api_key_id' is set
  if @api_client.config.client_side_validation && api_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_id' when calling UsersApi.update_api_key"
  end
  # verify the required parameter 'api_key_body' is set
  if @api_client.config.client_side_validation && api_key_body.nil?
    fail ArgumentError, "Missing the required parameter 'api_key_body' when calling UsersApi.update_api_key"
  end
  # resource path
  local_var_path = '/users/me/api_keys/{api_key_id}'.sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(api_key_body) 

  # return_type
  return_type = opts[:return_type] || 'ApiKeyFull' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_configuration(configuration_id, configuration_body, opts = {}) click to toggle source

Updates a specific configuration value. **API Key Scope**: configurations / update @param configuration_id [String] Numeric ID, or key of configuration. @param configuration_body [UserConfiguration] @param [Hash] opts the optional parameters @return [UserConfiguration]

# File lib/nodeum_sdk/api/users_api.rb, line 706
def update_configuration(configuration_id, configuration_body, opts = {})
  data, _status_code, _headers = update_configuration_with_http_info(configuration_id, configuration_body, opts)
  data
end
update_configuration_with_http_info(configuration_id, configuration_body, opts = {}) click to toggle source

Updates a specific configuration value. **API Key Scope**: configurations / update @param configuration_id [String] Numeric ID, or key of configuration. @param configuration_body [UserConfiguration] @param [Hash] opts the optional parameters @return [Array<(UserConfiguration, Integer, Hash)>] UserConfiguration data, response status code and response headers

# File lib/nodeum_sdk/api/users_api.rb, line 717
def update_configuration_with_http_info(configuration_id, configuration_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.update_configuration ...'
  end
  # verify the required parameter 'configuration_id' is set
  if @api_client.config.client_side_validation && configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_id' when calling UsersApi.update_configuration"
  end
  # verify the required parameter 'configuration_body' is set
  if @api_client.config.client_side_validation && configuration_body.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_body' when calling UsersApi.update_configuration"
  end
  # resource path
  local_var_path = '/users/me/configurations/{configuration_id}'.sub('{' + 'configuration_id' + '}', CGI.escape(configuration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(configuration_body) 

  # return_type
  return_type = opts[:return_type] || 'UserConfiguration' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end