Class: Hubspot::Marketing::Events::SearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/marketing/events/api/search_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SearchApi

Returns a new instance of SearchApi.



21
22
23
 
# File 'lib/hubspot/codegen/marketing/events/api/search_api.rb', line 21

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/marketing/events/api/search_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#do_search(q, opts = {}) ⇒ CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging

Search for marketing events Search for marketing events that have an event id that starts with the query string

Parameters:

  • q (String) —

    The partial event id to search for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/hubspot/codegen/marketing/events/api/search_api.rb', line 29

def do_search(q, opts = {})
  data, _status_code, _headers = do_search_with_http_info(q, opts)
  data
end

#do_search_with_http_info(q, opts = {}) ⇒ Array<(CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging, Integer, Hash)>

Search for marketing events Search for marketing events that have an event id that starts with the query string

Parameters:

  • q (String) —

    The partial event id to search for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/hubspot/codegen/marketing/events/api/search_api.rb', line 39

def do_search_with_http_info(q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchApi.do_search ...'
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling SearchApi.do_search"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/search'

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

  # 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] || 'CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging' 

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