class Hubspot::Cms::Blogs::Tags::DefaultApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 22
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

archive(object_id, opts = {}) click to toggle source

Delete a Blog Tag Delete the Blog Tag object identified by the id in the path. @param object_id [String] The Blog Tag id. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Whether to return only results that have been archived. @return [nil]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 31
def archive(object_id, opts = {})
  archive_with_http_info(object_id, opts)
  nil
end
archive_batch(batch_input_string, opts = {}) click to toggle source

Archive a batch of Blog Tags Delete the Blog Tag objects identified in the request body. Note: This is not the same as the in-app `archive` function. @param batch_input_string [BatchInputString] The JSON array of Blog Tag ids. @param [Hash] opts the optional parameters @return [nil]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 95
def archive_batch(batch_input_string, opts = {})
  archive_batch_with_http_info(batch_input_string, opts)
  nil
end
archive_batch_with_http_info(batch_input_string, opts = {}) click to toggle source

Archive a batch of Blog Tags Delete the Blog Tag objects identified in the request body. Note: This is not the same as the in-app &#x60;archive&#x60; function. @param batch_input_string [BatchInputString] The JSON array of Blog Tag ids. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 105
def archive_batch_with_http_info(batch_input_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.archive_batch ...'
  end
  # verify the required parameter 'batch_input_string' is set
  if @api_client.config.client_side_validation && batch_input_string.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling DefaultApi.archive_batch"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/batch/archive'

  # 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(['*/*'])
  # 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(batch_input_string) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#archive_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
archive_with_http_info(object_id, opts = {}) click to toggle source

Delete a Blog Tag Delete the Blog Tag object identified by the id in the path. @param object_id [String] The Blog Tag id. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Whether to return only results that have been archived. @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 42
def archive_with_http_info(object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.archive ...'
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling DefaultApi.archive"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))

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

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

  # 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] || ['hapikey', 'oauth2']

  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: DefaultApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create(tag, opts = {}) click to toggle source

Create a new Blog Tag Create a new Blog Tag. @param tag [Tag] The JSON representation of a new Blog Tag. @param [Hash] opts the optional parameters @return [Tag]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 159
def create(tag, opts = {})
  data, _status_code, _headers = create_with_http_info(tag, opts)
  data
end
create_batch(batch_input_tag, opts = {}) click to toggle source

Create a batch of Blog Tags Create the Blog Tag objects detailed in the request body. @param batch_input_tag [BatchInputTag] The JSON array of new Blog Tags to create. @param [Hash] opts the optional parameters @return [Object]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 223
def create_batch(batch_input_tag, opts = {})
  data, _status_code, _headers = create_batch_with_http_info(batch_input_tag, opts)
  data
end
create_batch_with_http_info(batch_input_tag, opts = {}) click to toggle source

Create a batch of Blog Tags Create the Blog Tag objects detailed in the request body. @param batch_input_tag [BatchInputTag] The JSON array of new Blog Tags to create. @param [Hash] opts the optional parameters @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 233
def create_batch_with_http_info(batch_input_tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_batch ...'
  end
  # verify the required parameter 'batch_input_tag' is set
  if @api_client.config.client_side_validation && batch_input_tag.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_tag' when calling DefaultApi.create_batch"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/batch/create'

  # 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(batch_input_tag) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#create_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_with_http_info(tag, opts = {}) click to toggle source

Create a new Blog Tag Create a new Blog Tag. @param tag [Tag] The JSON representation of a new Blog Tag. @param [Hash] opts the optional parameters @return [Array<(Tag, Integer, Hash)>] Tag data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 169
def create_with_http_info(tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create ...'
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling DefaultApi.create"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags'

  # 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(tag) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_by_id(object_id, opts = {}) click to toggle source

Retrieve a Blog Tag Retrieve the Blog Tag object identified by the id in the path. @param object_id [String] The Blog Tag id. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to return archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Tag]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 288
def get_by_id(object_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(object_id, opts)
  data
end
get_by_id_with_http_info(object_id, opts = {}) click to toggle source

Retrieve a Blog Tag Retrieve the Blog Tag object identified by the id in the path. @param object_id [String] The Blog Tag id. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to return archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Array<(Tag, Integer, Hash)>] Tag data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 299
def get_by_id_with_http_info(object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_by_id ...'
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling DefaultApi.get_by_id"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].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] || 'Tag' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_page(opts = {}) click to toggle source

Get all Blog Tags Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits. @param [Hash] opts the optional parameters @option opts [DateTime] :created_at Only return Blog Tags created at exactly the specified time. @option opts [DateTime] :created_after Only return Blog Tags created after the specified time. @option opts [DateTime] :created_before Only return Blog Tags created before the specified time. @option opts [DateTime] :updated_at Only return Blog Tags last updated at exactly the specified time. @option opts [DateTime] :updated_after Only return Blog Tags last updated after the specified time. @option opts [DateTime] :updated_before Only return Blog Tags last updated before the specified time. @option opts [Array<String>] :sort Specifies which fields to use for sorting results. Valid fields are &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;, &#x60;createdBy&#x60;, &#x60;updatedBy&#x60;. &#x60;createdAt&#x60; will be used by default. @option opts [String] :after The cursor token value to get the next set of results. You can get this from the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results. @option opts [Integer] :limit The maximum number of results to return. Default is 100. @option opts [Boolean] :archived Specifies whether to return archived Blog Tags. Defaults to &#x60;false&#x60;. @return [CollectionResponseWithTotalTagForwardPaging]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 361
def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end
get_page_with_http_info(opts = {}) click to toggle source

Get all Blog Tags Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits. @param [Hash] opts the optional parameters @option opts [DateTime] :created_at Only return Blog Tags created at exactly the specified time. @option opts [DateTime] :created_after Only return Blog Tags created after the specified time. @option opts [DateTime] :created_before Only return Blog Tags created before the specified time. @option opts [DateTime] :updated_at Only return Blog Tags last updated at exactly the specified time. @option opts [DateTime] :updated_after Only return Blog Tags last updated after the specified time. @option opts [DateTime] :updated_before Only return Blog Tags last updated before the specified time. @option opts [Array<String>] :sort Specifies which fields to use for sorting results. Valid fields are &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;, &#x60;createdBy&#x60;, &#x60;updatedBy&#x60;. &#x60;createdAt&#x60; will be used by default. @option opts [String] :after The cursor token value to get the next set of results. You can get this from the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results. @option opts [Integer] :limit The maximum number of results to return. Default is 100. @option opts [Boolean] :archived Specifies whether to return archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Array<(CollectionResponseWithTotalTagForwardPaging, Integer, Hash)>] CollectionResponseWithTotalTagForwardPaging data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 380
def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_page ...'
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'createdAt'] = opts[:'created_at'] if !opts[:'created_at'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'updatedAt'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
  query_params[:'updatedAfter'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
  query_params[:'updatedBefore'] = opts[:'updated_before'] if !opts[:'updated_before'].nil?
  query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].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] || 'CollectionResponseWithTotalTagForwardPaging' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read_batch(batch_input_string, opts = {}) click to toggle source

Retrieve a batch of Blog Tags Retrieve the Blog Tag objects identified in the request body. @param batch_input_string [BatchInputString] The JSON array of Blog Tag ids. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to return archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Object]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 439
def read_batch(batch_input_string, opts = {})
  data, _status_code, _headers = read_batch_with_http_info(batch_input_string, opts)
  data
end
read_batch_with_http_info(batch_input_string, opts = {}) click to toggle source

Retrieve a batch of Blog Tags Retrieve the Blog Tag objects identified in the request body. @param batch_input_string [BatchInputString] The JSON array of Blog Tag ids. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to return archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 450
def read_batch_with_http_info(batch_input_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.read_batch ...'
  end
  # verify the required parameter 'batch_input_string' is set
  if @api_client.config.client_side_validation && batch_input_string.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling DefaultApi.read_batch"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/batch/read'

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

  # 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(batch_input_string) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#read_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(object_id, tag, opts = {}) click to toggle source

Update a Blog Tag Sparse updates a single Blog Tag object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. @param object_id [String] The Blog Tag id. @param tag [Tag] The JSON representation of the updated Blog Tag. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to update archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Tag]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 507
def update(object_id, tag, opts = {})
  data, _status_code, _headers = update_with_http_info(object_id, tag, opts)
  data
end
update_batch(batch_input_json_node, opts = {}) click to toggle source

Update a batch of Blog Tags Update the Blog Tag objects identified in the request body. @param batch_input_json_node [BatchInputJsonNode] A JSON array of the JSON representations of the updated Blog Tags. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to update archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Object]

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 579
def update_batch(batch_input_json_node, opts = {})
  data, _status_code, _headers = update_batch_with_http_info(batch_input_json_node, opts)
  data
end
update_batch_with_http_info(batch_input_json_node, opts = {}) click to toggle source

Update a batch of Blog Tags Update the Blog Tag objects identified in the request body. @param batch_input_json_node [BatchInputJsonNode] A JSON array of the JSON representations of the updated Blog Tags. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to update archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 590
def update_batch_with_http_info(batch_input_json_node, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_batch ...'
  end
  # verify the required parameter 'batch_input_json_node' is set
  if @api_client.config.client_side_validation && batch_input_json_node.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_json_node' when calling DefaultApi.update_batch"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/batch/update'

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

  # 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(batch_input_json_node) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: DefaultApi#update_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_with_http_info(object_id, tag, opts = {}) click to toggle source

Update a Blog Tag Sparse updates a single Blog Tag object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. @param object_id [String] The Blog Tag id. @param tag [Tag] The JSON representation of the updated Blog Tag. @param [Hash] opts the optional parameters @option opts [Boolean] :archived Specifies whether to update archived Blog Tags. Defaults to &#x60;false&#x60;. @return [Array<(Tag, Integer, Hash)>] Tag data, response status code and response headers

# File lib/hubspot/codegen/cms/blogs/tags/api/default_api.rb, line 519
def update_with_http_info(object_id, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update ...'
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling DefaultApi.update"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling DefaultApi.update"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/tags/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))

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

  # 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(tag) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end