Class: Ovh::Api::Api::Telephony

Inherits:
Object
  • Object
show all
Defined in:
lib/ovh-api/api/telephony.rb

Defined Under Namespace

Classes: AbbreviatedNumber, Aliases, CarrierSip, Conference, Ddi, Directories, EasyHunting, Fax, HistoryConsumption, HistoryRepaymentConsumption, HistoryTollfreeConsumption, Line, Lines, Number, OfferTask, OutplanNotification, OvhPabx, Phonebook, Portability, Procedure, Redirect, Rsva, Scheduler, Screen, Service, Sounds, Spare, Task, TimeCondition, Trunk, Trunks, Voicemail, Vxml

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Telephony

Returns a new instance of Telephony.



6
7
8
 
# File 'lib/ovh-api/api/telephony.rb', line 6

def initialize(connection)
  @connection = connection
end

Instance Method Details

#accessories_get(country:, brand: nil) ⇒ Object

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/ovh-api/api/telephony.rb', line 10

def accessories_get(country:, brand: nil)
  raise ArgumentError, 'country is required' if country.nil?

  @connection.call(
    :GET,
    '/telephony/accessories',
    type: nil,
    auth: [],
    query: { 'brand' => brand, 'country' => country }
  )
end

#available_default_sip_domains_get(type:) ⇒ Object

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/ovh-api/api/telephony.rb', line 22

def available_default_sip_domains_get(type:)
  raise ArgumentError, 'type is required' if type.nil?

  @connection.call(
    :GET,
    '/telephony/availableDefaultSipDomains',
    type: nil,
    auth: [],
    query: { 'type' => type }
  )
end

#billing_account_allowed_credit_threshold_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/ovh-api/api/telephony.rb', line 34

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/allowedCreditThreshold'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_amount_security_deposit_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ovh-api/api/telephony.rb', line 46

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/amountSecurityDeposit'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_billing_account_site_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ovh-api/api/telephony.rb', line 58

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/billingAccountSite'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_billing_account_site_post(billing_account:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ovh-api/api/telephony.rb', line 70

def (billing_account:, body:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/telephony/{billingAccount}/billingAccountSite'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#billing_account_can_transfer_security_deposit_post(billing_account:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ovh-api/api/telephony.rb', line 84

def (billing_account:, body:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/telephony/{billingAccount}/canTransferSecurityDeposit'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#billing_account_cancel_termination_post(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ovh-api/api/telephony.rb', line 98

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :POST,
    '/telephony/{billingAccount}/cancelTermination'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_change_contact_post(billing_account:, cdn_dedicated_service_name_change_contact_post_request: nil) ⇒ Object

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/ovh-api/api/telephony.rb', line 110

def (billing_account:, cdn_dedicated_service_name_change_contact_post_request: nil)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :POST,
    '/telephony/{billingAccount}/changeContact'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: cdn_dedicated_service_name_change_contact_post_request
  )
end

#billing_account_delete(billing_account:, reason:, details: nil) ⇒ Object

Raises:

  • (ArgumentError) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/ovh-api/api/telephony.rb', line 123

def (billing_account:, reason:, details: nil)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'reason is required' if reason.nil?

  @connection.call(
    :DELETE,
    '/telephony/{billingAccount}'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    query: { 'details' => details, 'reason' => reason }
  )
end

#billing_account_event_token_delete(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ovh-api/api/telephony.rb', line 137

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :DELETE,
    '/telephony/{billingAccount}/eventToken'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_event_token_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/ovh-api/api/telephony.rb', line 149

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/eventToken'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_event_token_post(billing_account:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/ovh-api/api/telephony.rb', line 161

def (billing_account:, body:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/telephony/{billingAccount}/eventToken'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#billing_account_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/ovh-api/api/telephony.rb', line 175

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_has_special_numbers_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ovh-api/api/telephony.rb', line 187

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/hasSpecialNumbers'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_old_phone_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ovh-api/api/telephony.rb', line 199

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/oldPhone'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_put(billing_account:, telephony_billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/ovh-api/api/telephony.rb', line 211

def (billing_account:, telephony_billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'telephony_billing_account is required' if .nil?

  @connection.call(
    :PUT,
    '/telephony/{billingAccount}'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: 
  )
end

#billing_account_service_infos_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ovh-api/api/telephony.rb', line 225

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/serviceInfos'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_service_infos_put(billing_account:, services_service:) ⇒ Object

Raises:

  • (ArgumentError) 


237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/ovh-api/api/telephony.rb', line 237

def (billing_account:, services_service:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'services_service is required' if services_service.nil?

  @connection.call(
    :PUT,
    '/telephony/{billingAccount}/serviceInfos'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: services_service
  )
end

#billing_account_softphone_logo_delete(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/ovh-api/api/telephony.rb', line 251

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :DELETE,
    '/telephony/{billingAccount}/softphone/logo'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_softphone_logo_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/ovh-api/api/telephony.rb', line 263

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/softphone/logo'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_softphone_logo_put(billing_account:, telephony_softphone_logo:) ⇒ Object

Raises:

  • (ArgumentError) 


275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ovh-api/api/telephony.rb', line 275

def (billing_account:, telephony_softphone_logo:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'telephony_softphone_logo is required' if .nil?

  @connection.call(
    :PUT,
    '/telephony/{billingAccount}/softphone/logo'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: 
  )
end

#billing_account_softphone_theme_get(billing_account:) ⇒ Object

Raises:

  • (ArgumentError) 


289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/ovh-api/api/telephony.rb', line 289

def (billing_account:)
  raise ArgumentError, 'billing_account is required' if .nil?

  @connection.call(
    :GET,
    '/telephony/{billingAccount}/softphone/theme'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: []
  )
end

#billing_account_softphone_theme_put(billing_account:, telephony_softphone_theme_input:) ⇒ Object

Raises:

  • (ArgumentError) 


301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ovh-api/api/telephony.rb', line 301

def (billing_account:, telephony_softphone_theme_input:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'telephony_softphone_theme_input is required' if telephony_softphone_theme_input.nil?

  @connection.call(
    :PUT,
    '/telephony/{billingAccount}/softphone/theme'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: telephony_softphone_theme_input
  )
end

#billing_account_transfer_security_deposit_post(billing_account:, telephony_billing_account_transfer_security_deposit_post_request:) ⇒ Object

Raises:

  • (ArgumentError) 


315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/ovh-api/api/telephony.rb', line 315

def (billing_account:, telephony_billing_account_transfer_security_deposit_post_request:)
  raise ArgumentError, 'billing_account is required' if .nil?
  raise ArgumentError, 'telephony_billing_account_transfer_security_deposit_post_request is required' if .nil?

  @connection.call(
    :POST,
    '/telephony/{billingAccount}/transferSecurityDeposit'
      .gsub('{billingAccount}', ERB::Util.url_encode(.to_s)),
    type: nil,
    auth: [],
    body: 
  )
end

#current_order_ids_get ⇒ Object 



329
330
331
332
333
334
335
336
 
# File 'lib/ovh-api/api/telephony.rb', line 329

def current_order_ids_get
  @connection.call(
    :GET,
    '/telephony/currentOrderIds',
    type: nil,
    auth: []
  )
end

#get(iam_tags: nil) ⇒ Object 



338
339
340
341
342
343
344
345
346
 
# File 'lib/ovh-api/api/telephony.rb', line 338

def get(iam_tags: nil)
  @connection.call(
    :GET,
    '/telephony',
    type: nil,
    auth: [],
    query: { 'iamTags' => iam_tags }
  )
end

#reseller_panel_generate_password_post ⇒ Object 



348
349
350
351
352
353
354
355
 
# File 'lib/ovh-api/api/telephony.rb', line 348

def reseller_panel_generate_password_post
  @connection.call(
    :POST,
    '/telephony/resellerPanel/generatePassword',
    type: nil,
    auth: []
  )
end

#reseller_panel_status_get ⇒ Object 



357
358
359
360
361
362
363
364
 
# File 'lib/ovh-api/api/telephony.rb', line 357

def reseller_panel_status_get
  @connection.call(
    :GET,
    '/telephony/resellerPanel/status',
    type: nil,
    auth: []
  )
end

#search_services_get(axiom:) ⇒ Object

Raises:

  • (ArgumentError) 


366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ovh-api/api/telephony.rb', line 366

def search_services_get(axiom:)
  raise ArgumentError, 'axiom is required' if axiom.nil?

  @connection.call(
    :GET,
    '/telephony/searchServices',
    type: nil,
    auth: [],
    query: { 'axiom' => axiom }
  )
end

#set_default_sip_domain_post(telephony_set_default_sip_domain_post_request:) ⇒ Object

Raises:

  • (ArgumentError) 


378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ovh-api/api/telephony.rb', line 378

def set_default_sip_domain_post(telephony_set_default_sip_domain_post_request:)
  raise ArgumentError, 'telephony_set_default_sip_domain_post_request is required' if telephony_set_default_sip_domain_post_request.nil?

  @connection.call(
    :POST,
    '/telephony/setDefaultSipDomain',
    type: nil,
    auth: [],
    body: telephony_set_default_sip_domain_post_request
  )
end

#softphone_store_links_get ⇒ Object 



390
391
392
393
394
395
396
397
 
# File 'lib/ovh-api/api/telephony.rb', line 390

def softphone_store_links_get
  @connection.call(
    :GET,
    '/telephony/softphone/storeLinks',
    type: nil,
    auth: []
  )
end

#softphone_themes_get ⇒ Object 



399
400
401
402
403
404
405
406
 
# File 'lib/ovh-api/api/telephony.rb', line 399

def softphone_themes_get
  @connection.call(
    :GET,
    '/telephony/softphone/themes',
    type: nil,
    auth: []
  )
end

#softphone_themes_theme_id_get(theme_id:) ⇒ Object

Raises:

  • (ArgumentError) 


408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ovh-api/api/telephony.rb', line 408

def softphone_themes_theme_id_get(theme_id:)
  raise ArgumentError, 'theme_id is required' if theme_id.nil?

  @connection.call(
    :GET,
    '/telephony/softphone/themes/{themeId}'
      .gsub('{themeId}', ERB::Util.url_encode(theme_id.to_s)),
    type: nil,
    auth: []
  )
end