Class: Hubspot::Crm::Contacts::SearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/contacts/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/crm/contacts/api/search_api.rb', line 21

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


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

def api_client
  @api_client
end

Instance Method Details

#do_search(public_object_search_request, opts = {}) ⇒ CollectionResponseWithTotalSimplePublicObject

Filter, Sort, and Search CRM Objects Filter, Sort, and Search CRM Objects

Parameters:

Returns:


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

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

#do_search_with_http_info(public_object_search_request, opts = {}) ⇒ Array<(CollectionResponseWithTotalSimplePublicObject, Integer, Hash)>

Filter, Sort, and Search CRM Objects Filter, Sort, and Search CRM Objects

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
86
# File 'lib/hubspot/codegen/crm/contacts/api/search_api.rb', line 39

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

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

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

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