Class: Email::Pro

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Pro

Returns a new instance of Pro.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(iam_tags: nil) ⇒ Object 



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

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

#service_account_email_alias_alias_delete(alias_:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/ovh-api/api/email/pro.rb', line 20

def (alias_:, email:, service:)
  raise ArgumentError, 'alias_ is required' if alias_.nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/account/{email}/alias/{alias}'
      .gsub('{alias}', ERB::Util.url_encode(alias_.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_alias_alias_get(service:, alias_:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ovh-api/api/email/pro.rb', line 36

def (service:, alias_:, email:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'alias_ is required' if alias_.nil?
  raise ArgumentError, 'email is required' if email.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/alias/{alias}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{alias}', ERB::Util.url_encode(alias_.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_alias_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ovh-api/api/email/pro.rb', line 52

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

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/alias'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_alias_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/ovh-api/api/email/pro.rb', line 66

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/alias'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_change_password_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/changePassword'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_delete(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :DELETE,
    '/email/pro/{service}/account/{email}'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_diagnostics_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ovh-api/api/email/pro.rb', line 112

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

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/diagnostics'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_diagnostics_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/ovh-api/api/email/pro.rb', line 126

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/diagnostics'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_full_access_allowed_account_id_delete(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/ovh-api/api/email/pro.rb', line 142

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/account/{email}/fullAccess/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_full_access_allowed_account_id_get(service:, allowed_account_id:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/ovh-api/api/email/pro.rb', line 158

def (service:, allowed_account_id:, email:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/fullAccess/{allowedAccountId}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_full_access_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/fullAccess'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_full_access_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/ovh-api/api/email/pro.rb', line 188

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/fullAccess'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ovh-api/api/email/pro.rb', line 204

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

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

#service_account_email_put(email:, service:, email_pro_account:) ⇒ Object

Raises:

  • (ArgumentError) 


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ovh-api/api/email/pro.rb', line 218

def (email:, service:, email_pro_account:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_account is required' if .nil?

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

#service_account_email_send_as_allowed_account_id_delete(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/ovh-api/api/email/pro.rb', line 234

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/account/{email}/sendAs/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_as_allowed_account_id_get(service:, allowed_account_id:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/ovh-api/api/email/pro.rb', line 250

def (service:, allowed_account_id:, email:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/sendAs/{allowedAccountId}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_as_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/ovh-api/api/email/pro.rb', line 266

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

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/sendAs'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_as_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/ovh-api/api/email/pro.rb', line 280

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/sendAs'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_send_on_behalf_to_allowed_account_id_delete(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/ovh-api/api/email/pro.rb', line 296

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/account/{email}/sendOnBehalfTo/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_on_behalf_to_allowed_account_id_get(service:, allowed_account_id:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ovh-api/api/email/pro.rb', line 312

def (service:, allowed_account_id:, email:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/sendOnBehalfTo/{allowedAccountId}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_on_behalf_to_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ovh-api/api/email/pro.rb', line 328

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

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/sendOnBehalfTo'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_on_behalf_to_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ovh-api/api/email/pro.rb', line 342

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/sendOnBehalfTo'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_tasks_get(service:, email:) ⇒ Object

Raises:

  • (ArgumentError) 


358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ovh-api/api/email/pro.rb', line 358

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

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/tasks'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_tasks_id_get(service:, email:, id:) ⇒ Object

Raises:

  • (ArgumentError) 


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/ovh-api/api/email/pro.rb', line 372

def (service:, email:, id:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/account/{email}/tasks/{id}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_terminate_post(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ovh-api/api/email/pro.rb', line 388

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

  @connection.call(
    :POST,
    '/email/pro/{service}/account/{email}/terminate'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_get(service:, id: nil, primary_email_address: nil) ⇒ Object

Raises:

  • (ArgumentError) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ovh-api/api/email/pro.rb', line 402

def (service:, id: nil, primary_email_address: nil)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/account'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    query: { 'id' => id, 'primaryEmailAddress' => primary_email_address }
  )
end

#service_billing_migrated_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/ovh-api/api/email/pro.rb', line 415

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

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

#service_billing_plan_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/ovh-api/api/email/pro.rb', line 427

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

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

#service_change_contact_post(service:, cdn_dedicated_service_name_change_contact_post_request: nil) ⇒ Object

Raises:

  • (ArgumentError) 


439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/ovh-api/api/email/pro.rb', line 439

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

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

#service_domain_domain_name_delete(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/ovh-api/api/email/pro.rb', line 452

def service_domain_domain_name_delete(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/domain/{domainName}'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_attribute_get(service:, domain_name:) ⇒ Object

Raises:

  • (ArgumentError) 


466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/ovh-api/api/email/pro.rb', line 466

def service_domain_domain_name_disclaimer_attribute_get(service:, domain_name:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'domain_name is required' if domain_name.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain/{domainName}/disclaimerAttribute'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_delete(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/ovh-api/api/email/pro.rb', line 480

def service_domain_domain_name_disclaimer_delete(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_get(service:, domain_name:) ⇒ Object

Raises:

  • (ArgumentError) 


494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/ovh-api/api/email/pro.rb', line 494

def service_domain_domain_name_disclaimer_get(service:, domain_name:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'domain_name is required' if domain_name.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain/{domainName}/disclaimer'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_post(domain_name:, service:, email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2:) ⇒ Object

Raises:

  • (ArgumentError) 


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/ovh-api/api/email/pro.rb', line 508

def service_domain_domain_name_disclaimer_post(domain_name:, service:, email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2 is required' if email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2.nil?

  @connection.call(
    :POST,
    '/email/pro/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2
  )
end

#service_domain_domain_name_disclaimer_put(domain_name:, service:, email_pro_disclaimer:) ⇒ Object

Raises:

  • (ArgumentError) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/ovh-api/api/email/pro.rb', line 524

def service_domain_domain_name_disclaimer_put(domain_name:, service:, email_pro_disclaimer:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_disclaimer is required' if email_pro_disclaimer.nil?

  @connection.call(
    :PUT,
    '/email/pro/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_pro_disclaimer
  )
end

#service_domain_domain_name_dkim_get(service:, domain_name:) ⇒ Object

Raises:

  • (ArgumentError) 


540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/ovh-api/api/email/pro.rb', line 540

def service_domain_domain_name_dkim_get(service:, domain_name:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'domain_name is required' if domain_name.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain/{domainName}/dkim'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_dkim_post(domain_name:, service:, email_exchange_organization_name_service_exchange_service_doma_h39027816:) ⇒ Object

Raises:

  • (ArgumentError) 


554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/ovh-api/api/email/pro.rb', line 554

def service_domain_domain_name_dkim_post(domain_name:, service:, email_exchange_organization_name_service_exchange_service_doma_h39027816:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_exchange_organization_name_service_exchange_service_doma_h39027816 is required' if email_exchange_organization_name_service_exchange_service_doma_h39027816.nil?

  @connection.call(
    :POST,
    '/email/pro/{service}/domain/{domainName}/dkim'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_exchange_organization_name_service_exchange_service_doma_h39027816
  )
end

#service_domain_domain_name_dkim_selector_get(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/ovh-api/api/email/pro.rb', line 570

def service_domain_domain_name_dkim_selector_get(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain/{domainName}/dkimSelector'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_dkim_selector_name_delete(domain_name:, selector_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/ovh-api/api/email/pro.rb', line 584

def service_domain_domain_name_dkim_selector_name_delete(domain_name:, selector_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'selector_name is required' if selector_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/domain/{domainName}/dkim/{selectorName}'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{selectorName}', ERB::Util.url_encode(selector_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_dkim_selector_name_disable_post(domain_name:, selector_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/ovh-api/api/email/pro.rb', line 600

def service_domain_domain_name_dkim_selector_name_disable_post(domain_name:, selector_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'selector_name is required' if selector_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :POST,
    '/email/pro/{service}/domain/{domainName}/dkim/{selectorName}/disable'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{selectorName}', ERB::Util.url_encode(selector_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_dkim_selector_name_enable_post(domain_name:, selector_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/ovh-api/api/email/pro.rb', line 616

def service_domain_domain_name_dkim_selector_name_enable_post(domain_name:, selector_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'selector_name is required' if selector_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :POST,
    '/email/pro/{service}/domain/{domainName}/dkim/{selectorName}/enable'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{selectorName}', ERB::Util.url_encode(selector_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_dkim_selector_name_get(service:, domain_name:, selector_name:) ⇒ Object

Raises:

  • (ArgumentError) 


632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/ovh-api/api/email/pro.rb', line 632

def service_domain_domain_name_dkim_selector_name_get(service:, domain_name:, selector_name:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'selector_name is required' if selector_name.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain/{domainName}/dkim/{selectorName}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{selectorName}', ERB::Util.url_encode(selector_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_get(service:, domain_name:) ⇒ Object

Raises:

  • (ArgumentError) 


648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/ovh-api/api/email/pro.rb', line 648

def service_domain_domain_name_get(service:, domain_name:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'domain_name is required' if domain_name.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain/{domainName}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_put(domain_name:, service:, email_pro_domain:) ⇒ Object

Raises:

  • (ArgumentError) 


662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/ovh-api/api/email/pro.rb', line 662

def service_domain_domain_name_put(domain_name:, service:, email_pro_domain:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_domain is required' if email_pro_domain.nil?

  @connection.call(
    :PUT,
    '/email/pro/{service}/domain/{domainName}'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_pro_domain
  )
end

#service_domain_get(service:, state: nil) ⇒ Object

Raises:

  • (ArgumentError) 


678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/ovh-api/api/email/pro.rb', line 678

def service_domain_get(service:, state: nil)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/domain'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    query: { 'state' => state }
  )
end

#service_domain_post(service:, email_pro_service_domain_post_request:) ⇒ Object

Raises:

  • (ArgumentError) 


691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/ovh-api/api/email/pro.rb', line 691

def service_domain_post(service:, email_pro_service_domain_post_request:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_service_domain_post_request is required' if email_pro_service_domain_post_request.nil?

  @connection.call(
    :POST,
    '/email/pro/{service}/domain'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_pro_service_domain_post_request
  )
end

#service_external_contact_external_email_address_delete(external_email_address:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/ovh-api/api/email/pro.rb', line 705

def service_external_contact_external_email_address_delete(external_email_address:, service:)
  raise ArgumentError, 'external_email_address is required' if external_email_address.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/pro/{service}/externalContact/{externalEmailAddress}'
      .gsub('{externalEmailAddress}', ERB::Util.url_encode(external_email_address.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_external_contact_external_email_address_get(service:, external_email_address:) ⇒ Object

Raises:

  • (ArgumentError) 


719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/ovh-api/api/email/pro.rb', line 719

def service_external_contact_external_email_address_get(service:, external_email_address:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'external_email_address is required' if external_email_address.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/externalContact/{externalEmailAddress}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{externalEmailAddress}', ERB::Util.url_encode(external_email_address.to_s)),
    type: nil,
    auth: []
  )
end

#service_external_contact_external_email_address_put(external_email_address:, service:, email_pro_external_contact:) ⇒ Object

Raises:

  • (ArgumentError) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/ovh-api/api/email/pro.rb', line 733

def service_external_contact_external_email_address_put(external_email_address:, service:, email_pro_external_contact:)
  raise ArgumentError, 'external_email_address is required' if external_email_address.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_external_contact is required' if email_pro_external_contact.nil?

  @connection.call(
    :PUT,
    '/email/pro/{service}/externalContact/{externalEmailAddress}'
      .gsub('{externalEmailAddress}', ERB::Util.url_encode(external_email_address.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_pro_external_contact
  )
end

#service_external_contact_get(service:, display_name: nil, external_email_address: nil, first_name: nil, id: nil, last_name: nil) ⇒ Object

Raises:

  • (ArgumentError) 


749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/ovh-api/api/email/pro.rb', line 749

def service_external_contact_get(service:, display_name: nil, external_email_address: nil, first_name: nil, id: nil, last_name: nil)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/externalContact'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    query: { 'displayName' => display_name, 'externalEmailAddress' => external_email_address, 'firstName' => first_name, 'id' => id, 'lastName' => last_name }
  )
end

#service_external_contact_post(service:, email_mxplan_service_external_contact_post_request:) ⇒ Object

Raises:

  • (ArgumentError) 


762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/ovh-api/api/email/pro.rb', line 762

def service_external_contact_post(service:, email_mxplan_service_external_contact_post_request:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_mxplan_service_external_contact_post_request is required' if email_mxplan_service_external_contact_post_request.nil?

  @connection.call(
    :POST,
    '/email/pro/{service}/externalContact'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_mxplan_service_external_contact_post_request
  )
end

#service_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/ovh-api/api/email/pro.rb', line 776

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

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

#service_put(service:, email_pro_service:) ⇒ Object

Raises:

  • (ArgumentError) 


788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/ovh-api/api/email/pro.rb', line 788

def service_put(service:, email_pro_service:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_service is required' if email_pro_service.nil?

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

#service_server_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/ovh-api/api/email/pro.rb', line 802

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

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

#service_service_infos_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/ovh-api/api/email/pro.rb', line 814

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

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

#service_service_infos_put(service:, services_service:) ⇒ Object

Raises:

  • (ArgumentError) 


826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/ovh-api/api/email/pro.rb', line 826

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

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

#service_task_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/ovh-api/api/email/pro.rb', line 840

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

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

#service_task_id_get(service:, id:) ⇒ Object

Raises:

  • (ArgumentError) 


852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/ovh-api/api/email/pro.rb', line 852

def service_task_id_get(service:, id:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :GET,
    '/email/pro/{service}/task/{id}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s))
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: []
  )
end

#service_update_flags_on_all_accounts_post(service:) ⇒ Object

Raises:

  • (ArgumentError) 


866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/ovh-api/api/email/pro.rb', line 866

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

  @connection.call(
    :POST,
    '/email/pro/{service}/updateFlagsOnAllAccounts'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end