class KoronaClient::TagsApi
Attributes
Public Class Methods
# File lib/korona_client/api/tags_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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
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
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
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
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
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