Class: ClickSendClient::NumberApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/number_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NumberApi

Returns a new instance of NumberApi.



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

def api_client
  @api_client
end

Instance Method Details

#numbers_buy_by_dedicated_number_post(dedicated_number, opts = {}) ⇒ String

Buy dedicated number Buy dedicated number

Parameters:

  • dedicated_number —

    Phone number to purchase

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/clicksend_client/api/number_api.rb', line 27

def numbers_buy_by_dedicated_number_post(dedicated_number, opts = {})
  data, _status_code, _headers = numbers_buy_by_dedicated_number_post_with_http_info(dedicated_number, opts)
  data
end

#numbers_buy_by_dedicated_number_post_with_http_info(dedicated_number, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Buy dedicated number Buy dedicated number

Parameters:

  • dedicated_number —

    Phone number to purchase

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



37
38
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
 
# File 'lib/clicksend_client/api/number_api.rb', line 37

def numbers_buy_by_dedicated_number_post_with_http_info(dedicated_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumberApi.numbers_buy_by_dedicated_number_post ...'
  end
  # verify the required parameter 'dedicated_number' is set
  if @api_client.config.client_side_validation && dedicated_number.nil?
    fail ArgumentError, "Missing the required parameter 'dedicated_number' when calling NumberApi.numbers_buy_by_dedicated_number_post"
  end
  # resource path
  local_var_path = '/numbers/buy/{dedicated_number}'.sub('{' + 'dedicated_number' + '}', dedicated_number.to_s)

  # query parameters
  query_params = {}

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

#numbers_get(opts = {}) ⇒ String

Get all availible dedicated numbers Get all availible dedicated numbers

Parameters:

  • 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) 


82
83
84
85
 
# File 'lib/clicksend_client/api/number_api.rb', line 82

def numbers_get(opts = {})
  data, _status_code, _headers = numbers_get_with_http_info(opts)
  data
end

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

Get all availible dedicated numbers Get all availible dedicated numbers

Parameters:

  • 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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/clicksend_client/api/number_api.rb', line 93

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

  # resource path
  local_var_path = '/numbers'

  # query parameters
  query_params = {}
  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: NumberApi#numbers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#numbers_search_by_country_get(country, opts = {}) ⇒ String

Get all dedicated numbers by country Get all dedicated numbers by country

Parameters:

  • country —

    Country code to search

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Your search pattern or query.

  • :search_type (Integer) —

    Your strategy for searching, 0 &#x3D; starts with, 1 &#x3D; anywhere, 2 &#x3D; ends with.

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


147
148
149
150
 
# File 'lib/clicksend_client/api/number_api.rb', line 147

def numbers_search_by_country_get(country, opts = {})
  data, _status_code, _headers = numbers_search_by_country_get_with_http_info(country, opts)
  data
end

#numbers_search_by_country_get_with_http_info(country, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all dedicated numbers by country Get all dedicated numbers by country

Parameters:

  • country —

    Country code to search

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Your search pattern or query.

  • :search_type (Integer) —

    Your strategy for searching, 0 &#x3D; starts with, 1 &#x3D; anywhere, 2 &#x3D; ends with.

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/clicksend_client/api/number_api.rb', line 161

def numbers_search_by_country_get_with_http_info(country, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumberApi.numbers_search_by_country_get ...'
  end
  # verify the required parameter 'country' is set
  if @api_client.config.client_side_validation && country.nil?
    fail ArgumentError, "Missing the required parameter 'country' when calling NumberApi.numbers_search_by_country_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling NumberApi.numbers_search_by_country_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 NumberApi.numbers_search_by_country_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/numbers/search/{country}'.sub('{' + 'country' + '}', country.to_s)

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'search_type'] = opts[:'search_type'] if !opts[:'search_type'].nil?
  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: NumberApi#numbers_search_by_country_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end