class Hubspot::Cms::UrlRedirects::RedirectsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 21
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

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

Delete a redirect Delete one existing redirect, so it is no longer mapped. @param url_redirect_id [String] The ID of the target redirect. @param [Hash] opts the optional parameters @return [nil]

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 29
def archive(url_redirect_id, opts = {})
  archive_with_http_info(url_redirect_id, opts)
  nil
end
archive_with_http_info(url_redirect_id, opts = {}) click to toggle source

Delete a redirect Delete one existing redirect, so it is no longer mapped. @param url_redirect_id [String] The ID of the target redirect. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 39
def archive_with_http_info(url_redirect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.archive ...'
  end
  # verify the required parameter 'url_redirect_id' is set
  if @api_client.config.client_side_validation && url_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.archive"
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_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(['*/*'])

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

Create a redirect Creates and configures a new URL redirect. @param [Hash] opts the optional parameters @option opts [UrlMappingCreateRequestBody] :url_mapping_create_request_body @return [UrlMapping]

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 91
def create(opts = {})
  data, _status_code, _headers = create_with_http_info(opts)
  data
end
create_with_http_info(opts = {}) click to toggle source

Create a redirect Creates and configures a new URL redirect. @param [Hash] opts the optional parameters @option opts [UrlMappingCreateRequestBody] :url_mapping_create_request_body @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 101
def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.create ...'
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/'

  # 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(opts[:'url_mapping_create_request_body']) 

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

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

Get details for a redirect Returns the details for a single existing URL redirect by ID. @param url_redirect_id [String] The ID of the target redirect. @param [Hash] opts the optional parameters @return [UrlMapping]

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 151
def get_by_id(url_redirect_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(url_redirect_id, opts)
  data
end
get_by_id_with_http_info(url_redirect_id, opts = {}) click to toggle source

Get details for a redirect Returns the details for a single existing URL redirect by ID. @param url_redirect_id [String] The ID of the target redirect. @param [Hash] opts the optional parameters @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 161
def get_by_id_with_http_info(url_redirect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.get_by_id ...'
  end
  # verify the required parameter 'url_redirect_id' is set
  if @api_client.config.client_side_validation && url_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.get_by_id"
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_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] || 'UrlMapping' 

  # 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: RedirectsApi#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 current redirects Returns all existing URL redirects. Results can be limited and filtered by creation or updated date. @param [Hash] opts the optional parameters @option opts [DateTime] :created_at Only return redirects created on exactly this date. @option opts [DateTime] :created_after Only return redirects created after this date. @option opts [DateTime] :created_before Only return redirects created before this date. @option opts [DateTime] :updated_at Only return redirects last updated on exactly this date. @option opts [DateTime] :updated_after Only return redirects last updated after this date. @option opts [DateTime] :updated_before Only return redirects last updated before this date. @option opts [Array<String>] :sort @option opts [Array<String>] :properties @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results. @option opts [String] :before @option opts [Integer] :limit Maximum number of result per page @option opts [Boolean] :archived Whether to return only results that have been archived. @return [CollectionResponseWithTotalUrlMapping]

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 224
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 current redirects Returns all existing URL redirects. Results can be limited and filtered by creation or updated date. @param [Hash] opts the optional parameters @option opts [DateTime] :created_at Only return redirects created on exactly this date. @option opts [DateTime] :created_after Only return redirects created after this date. @option opts [DateTime] :created_before Only return redirects created before this date. @option opts [DateTime] :updated_at Only return redirects last updated on exactly this date. @option opts [DateTime] :updated_after Only return redirects last updated after this date. @option opts [DateTime] :updated_before Only return redirects last updated before this date. @option opts [Array<String>] :sort @option opts [Array<String>] :properties @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results. @option opts [String] :before @option opts [Integer] :limit Maximum number of result per page @option opts [Boolean] :archived Whether to return only results that have been archived. @return [Array<(CollectionResponseWithTotalUrlMapping, Integer, Hash)>] CollectionResponseWithTotalUrlMapping data, response status code and response headers

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 245
def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.get_page ...'
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/'

  # 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[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].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] || 'CollectionResponseWithTotalUrlMapping' 

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

Update a redirect Updates the settings for an existing URL redirect. @param url_redirect_id [String] @param [Hash] opts the optional parameters @option opts [UrlMapping] :url_mapping @return [UrlMapping]

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 306
def update(url_redirect_id, opts = {})
  data, _status_code, _headers = update_with_http_info(url_redirect_id, opts)
  data
end
update_with_http_info(url_redirect_id, opts = {}) click to toggle source

Update a redirect Updates the settings for an existing URL redirect. @param url_redirect_id [String] @param [Hash] opts the optional parameters @option opts [UrlMapping] :url_mapping @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers

# File lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb, line 317
def update_with_http_info(url_redirect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.update ...'
  end
  # verify the required parameter 'url_redirect_id' is set
  if @api_client.config.client_side_validation && url_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.update"
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_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(opts[:'url_mapping']) 

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

  # 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: RedirectsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end