class KoronaClient::TagsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

add_tags(korona_account_id, body, opts = {}) click to toggle source

adds a batch of new tags

@param korona_account_id account id of the KORONA.cloud account @param body array of new tags @param [Hash] opts the optional parameters @option opts [BOOLEAN] :upsert when set to true, updates the object instead of generating a already-exists-error @return [Array<AddOrUpdateResult>]

# File lib/korona_client/api/tags_api.rb, line 29
def add_tags(korona_account_id, body, opts = {})
  data, _status_code, _headers = add_tags_with_http_info(korona_account_id, body, opts)
  data
end
add_tags_with_http_info(korona_account_id, body, opts = {}) click to toggle source

adds a batch of new tags

@param korona_account_id account id of the KORONA.cloud account @param body array of new tags @param [Hash] opts the optional parameters @option opts [BOOLEAN] :upsert when set to true, updates the object instead of generating a already-exists-error @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 41
def add_tags_with_http_info(korona_account_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.add_tags ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.add_tags"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TagsApi.add_tags"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s)

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

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  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 => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#add_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_tag(korona_account_id, tag_id, opts = {}) click to toggle source

deletes the single tag

@param korona_account_id account id of the KORONA.cloud account @param tag_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [nil]

# File lib/korona_client/api/tags_api.rb, line 91
def delete_tag(korona_account_id, tag_id, opts = {})
  delete_tag_with_http_info(korona_account_id, tag_id, opts)
  nil
end
delete_tag_with_http_info(korona_account_id, tag_id, opts = {}) click to toggle source

deletes the single tag

@param korona_account_id account id of the KORONA.cloud account @param tag_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 102
def delete_tag_with_http_info(korona_account_id, tag_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.delete_tag"
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.delete_tag"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags/{tagId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_tags(korona_account_id, body, opts = {}) click to toggle source

deletes a batch of tags

@param korona_account_id account id of the KORONA.cloud account @param body array of existing tags (id or number required) @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]

# File lib/korona_client/api/tags_api.rb, line 150
def delete_tags(korona_account_id, body, opts = {})
  data, _status_code, _headers = delete_tags_with_http_info(korona_account_id, body, opts)
  data
end
delete_tags_with_http_info(korona_account_id, body, opts = {}) click to toggle source

deletes a batch of tags

@param korona_account_id account id of the KORONA.cloud account @param body array of existing tags (id or number required) @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 161
def delete_tags_with_http_info(korona_account_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.delete_tags ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.delete_tags"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TagsApi.delete_tags"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#delete_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_tag(korona_account_id, tag_id, opts = {}) click to toggle source

returns the single tag

@param korona_account_id account id of the KORONA.cloud account @param tag_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Tag]

# File lib/korona_client/api/tags_api.rb, line 210
def get_tag(korona_account_id, tag_id, opts = {})
  data, _status_code, _headers = get_tag_with_http_info(korona_account_id, tag_id, opts)
  data
end
get_tag_with_http_info(korona_account_id, tag_id, opts = {}) click to toggle source

returns the single tag

@param korona_account_id account id of the KORONA.cloud account @param tag_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(Tag, Fixnum, Hash)>] Tag data, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 221
def get_tag_with_http_info(korona_account_id, tag_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.get_tag"
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.get_tag"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags/{tagId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  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 => 'Tag')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_tags(korona_account_id, opts = {}) click to toggle source

lists all tags

@param korona_account_id account id of the KORONA.cloud account @param [Hash] opts the optional parameters @option opts [Integer] :page number of the page to fetch @option opts [Integer] :size amount of objects to return per page @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5) @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned @option opts [BOOLEAN] :include_deleted indicates deleted objects should be loaded or not (default: false) @return [ResultListTag]

# File lib/korona_client/api/tags_api.rb, line 274
def get_tags(korona_account_id, opts = {})
  data, _status_code, _headers = get_tags_with_http_info(korona_account_id, opts)
  data
end
get_tags_with_http_info(korona_account_id, opts = {}) click to toggle source

lists all tags

@param korona_account_id account id of the KORONA.cloud account @param [Hash] opts the optional parameters @option opts [Integer] :page number of the page to fetch @option opts [Integer] :size amount of objects to return per page @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5) @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned @option opts [BOOLEAN] :include_deleted indicates deleted objects should be loaded or not (default: false) @return [Array<(ResultListTag, Fixnum, Hash)>] ResultListTag data, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 289
def get_tags_with_http_info(korona_account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.get_tags"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  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 => 'ResultListTag')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_tag(korona_account_id, tag_id, body, opts = {}) click to toggle source

updates the single tag

@param korona_account_id account id of the KORONA.cloud account @param tag_id id of the related object (important: id should match the uuid-format) @param body the properties to update of the tag @param [Hash] opts the optional parameters @return [nil]

# File lib/korona_client/api/tags_api.rb, line 340
def update_tag(korona_account_id, tag_id, body, opts = {})
  update_tag_with_http_info(korona_account_id, tag_id, body, opts)
  nil
end
update_tag_with_http_info(korona_account_id, tag_id, body, opts = {}) click to toggle source

updates the single tag

@param korona_account_id account id of the KORONA.cloud account @param tag_id id of the related object (important: id should match the uuid-format) @param body the properties to update of the tag @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 352
def update_tag_with_http_info(korona_account_id, tag_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.update_tag"
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.update_tag"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TagsApi.update_tag"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags/{tagId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

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

updates a batch of tags

@param korona_account_id account id of the KORONA.cloud account @param body array of existing tags (id or number required) @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]

# File lib/korona_client/api/tags_api.rb, line 404
def update_tags(korona_account_id, body, opts = {})
  data, _status_code, _headers = update_tags_with_http_info(korona_account_id, body, opts)
  data
end
update_tags_with_http_info(korona_account_id, body, opts = {}) click to toggle source

updates a batch of tags

@param korona_account_id account id of the KORONA.cloud account @param body array of existing tags (id or number required) @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers

# File lib/korona_client/api/tags_api.rb, line 415
def update_tags_with_http_info(korona_account_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.update_tags ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TagsApi.update_tags"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TagsApi.update_tags"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tags'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

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