Class: SwaggerClient::SearchControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/search_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SearchControllerApi

Returns a new instance of SearchControllerApi.



19
20
21
 
# File 'lib/swagger_client/api/search_controller_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/swagger_client/api/search_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#search_using_get(type, opts = {}) ⇒ Array<Object>

Search infrastructure

Parameters:

  • type —

    type

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    q

  • :platform (String) —

    platform

  • :page_size (Integer) —

    pageSize (default to 10000)

  • :page (Integer) —

    page (default to 1)

  • :allow_short_query (BOOLEAN) —

    allowShortQuery (default to false)

  • :x_rate_limit_app (String) —

    X-RateLimit-App

Returns:

  • (Array<Object>) 


32
33
34
35
 
# File 'lib/swagger_client/api/search_controller_api.rb', line 32

def search_using_get(type, opts = {})
  data, _status_code, _headers = search_using_get_with_http_info(type, opts)
  data
end

#search_using_get_with_http_info(type, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Search infrastructure

Parameters:

  • type —

    type

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    q

  • :platform (String) —

    platform

  • :page_size (Integer) —

    pageSize

  • :page (Integer) —

    page

  • :allow_short_query (BOOLEAN) —

    allowShortQuery

  • :x_rate_limit_app (String) —

    X-RateLimit-App

Returns:

  • (Array<(Array<Object>, Fixnum, Hash)>) —

    Array data, response status code and response headers

    

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
87
88
89
90
91
92
    		 
    # File 'lib/swagger_client/api/search_controller_api.rb', line 47

def search_using_get_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchControllerApi.search_using_get ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling SearchControllerApi.search_using_get"
  end
  # resource path
  local_var_path = '/search'

  # query parameters
  query_params = {}
  query_params[:'type'] = type
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'allowShortQuery'] = opts[:'allow_short_query'] if !opts[:'allow_short_query'].nil?

  # header parameters
  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'])
  header_params[:'X-RateLimit-App'] = opts[:'x_rate_limit_app'] if !opts[:'x_rate_limit_app'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchControllerApi#search_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end