Class: ClickSendClient::SearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/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.



19
20
21
 
# File 'lib/clicksend_client/api/search_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/clicksend_client/api/search_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#search_contacts_lists_get(q, opts = {}) ⇒ String

Get list of searched contact list Get list of searched contact list

Parameters:

  • q —

    Your keyword or query.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


29
30
31
32
 
# File 'lib/clicksend_client/api/search_api.rb', line 29

def search_contacts_lists_get(q, opts = {})
  data, _status_code, _headers = search_contacts_lists_get_with_http_info(q, opts)
  data
end

#search_contacts_lists_get_with_http_info(q, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get list of searched contact list Get list of searched contact list

Parameters:

  • q —

    Your keyword or query.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



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
87
88
89
90
 
# File 'lib/clicksend_client/api/search_api.rb', line 41

def search_contacts_lists_get_with_http_info(q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchApi.search_contacts_lists_get ...'
  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.search_contacts_lists_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SearchApi.search_contacts_lists_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SearchApi.search_contacts_lists_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/search/contacts-lists'

  # query parameters
  query_params = {}
  query_params[:'q'] = q
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  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 = {}

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