Class: Daily::PhoneNumbersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/daily-ruby/api/phone_numbers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PhoneNumbersApi

Returns a new instance of PhoneNumbersApi.



19
20
21
 
# File 'lib/daily-ruby/api/phone_numbers_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/daily-ruby/api/phone_numbers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#buy_phone_number(opts = {}) ⇒ Object

/buy-phone-number This will buy a phone number. In the POST request you can either provide the phone number you want to buy, or leave it empty. If the specified ‘number` is still available, it will be bought or the API will return a failure. Alternatively, if you skipped the `number` field, a random phone number from California (CA) will be bought.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 27

def buy_phone_number(opts = {})
  data, _status_code, _headers = buy_phone_number_with_http_info(opts)
  data
end

#buy_phone_number_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

/buy-phone-number This will buy a phone number. In the POST request you can either provide the phone number you want to buy, or leave it empty. If the specified &#x60;number&#x60; is still available, it will be bought or the API will return a failure. Alternatively, if you skipped the &#x60;number&#x60; field, a random phone number from California (CA) will be bought.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object 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
76
77
78
79
80
81
82
83
84
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 37

def buy_phone_number_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.buy_phone_number ...'
  end
  # resource path
  local_var_path = '/buy-phone-number'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'buy_phone_number_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sec0']

  new_options = opts.merge(
    :operation => :"PhoneNumbersApi.buy_phone_number",
    :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: PhoneNumbersApi#buy_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_available_numbers(opts = {}) ⇒ nil

/list-available-numbers Search for available phone numbers to purchase

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :areacode (String) —

    An areacode to search within.

  • :region (String) —

    A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. CA for California. Cannot be used in combination with areacode.

  • :city (String) —

    A specific City to search within. Example, New York. The string must be url encoded because it is a url parameter. Must be used in combination with region. Cannot be used in combination with areacode, starts_with, contains, or ends_with.

  • :contains (String) —

    A string of 3 to 7 digits that should appear somewhere in the number.

  • :starts_with (String) —

    A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.

  • :ends_with (String) —

    A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 96

def list_available_numbers(opts = {})
  list_available_numbers_with_http_info(opts)
  nil
end

#list_available_numbers_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

/list-available-numbers Search for available phone numbers to purchase

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :areacode (String) —

    An areacode to search within.

  • :region (String) —

    A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. CA for California. Cannot be used in combination with areacode.

  • :city (String) —

    A specific City to search within. Example, New York. The string must be url encoded because it is a url parameter. Must be used in combination with region. Cannot be used in combination with areacode, starts_with, contains, or ends_with.

  • :contains (String) —

    A string of 3 to 7 digits that should appear somewhere in the number.

  • :starts_with (String) —

    A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.

  • :ends_with (String) —

    A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 111

def list_available_numbers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.list_available_numbers ...'
  end
  # resource path
  local_var_path = '/list-available-numbers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'areacode'] = opts[:'areacode'] if !opts[:'areacode'].nil?
  query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
  query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
  query_params[:'contains'] = opts[:'contains'] if !opts[:'contains'].nil?
  query_params[:'starts_with'] = opts[:'starts_with'] if !opts[:'starts_with'].nil?
  query_params[:'ends_with'] = opts[:'ends_with'] if !opts[:'ends_with'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sec0']

  new_options = opts.merge(
    :operation => :"PhoneNumbersApi.list_available_numbers",
    :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: PhoneNumbersApi#list_available_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchased_phone_nunbers(opts = {}) ⇒ nil

/purchased-phone-numbers List the purchased phone numbers for this domain

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


165
166
167
168
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 165

def purchased_phone_nunbers(opts = {})
  purchased_phone_nunbers_with_http_info(opts)
  nil
end

#purchased_phone_nunbers_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

/purchased-phone-numbers List the purchased phone numbers for this domain

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
212
213
214
215
216
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 174

def purchased_phone_nunbers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.purchased_phone_nunbers ...'
  end
  # resource path
  local_var_path = '/purchased-phone-numbers'

  # 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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sec0']

  new_options = opts.merge(
    :operation => :"PhoneNumbersApi.purchased_phone_nunbers",
    :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: PhoneNumbersApi#purchased_phone_nunbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#release_phone_number(id, opts = {}) ⇒ Object

release-phone-number/:id Release a purchased number. The number is referenced by its id. A number cannot be deleted within the 14 days of purchase. Calling this API before this period expires results in an error.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


223
224
225
226
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 223

def release_phone_number(id, opts = {})
  data, _status_code, _headers = release_phone_number_with_http_info(id, opts)
  data
end

#release_phone_number_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

release-phone-number/:id Release a purchased number. The number is referenced by its id. A number cannot be deleted within the 14 days of purchase. Calling this API before this period expires results in an error.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/daily-ruby/api/phone_numbers_api.rb', line 233

def release_phone_number_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.release_phone_number ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PhoneNumbersApi.release_phone_number"
  end
  # resource path
  local_var_path = '/release-phone-number/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sec0']

  new_options = opts.merge(
    :operation => :"PhoneNumbersApi.release_phone_number",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneNumbersApi#release_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end