Class: Norbelys::DomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/norbelys/api/domains_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainsApi

Returns a new instance of DomainsApi.



19
20
21
 
# File 'lib/norbelys/api/domains_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/norbelys/api/domains_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#domains_archive(id, opts = {}) ⇒ Domain

Archive a domain Soft-archive a domain (it is versioned, never hard-deleted). Archiving a monitoring domain also revokes its collection addresses, so DMARC report ingestion stops with it; restore re-enables them.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/norbelys/api/domains_api.rb', line 27

def domains_archive(id, opts = {})
  data, _status_code, _headers = domains_archive_with_http_info(id, opts)
  data
end

#domains_archive_with_http_info(id, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Archive a domain Soft-archive a domain (it is versioned, never hard-deleted). Archiving a monitoring domain also revokes its collection addresses, so DMARC report ingestion stops with it; restore re-enables them.

Parameters:

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

    the optional parameters

Returns:

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

    Domain 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
 
# File 'lib/norbelys/api/domains_api.rb', line 37

def domains_archive_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_archive ...'
  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 DomainsApi.domains_archive"
  end
  # resource path
  local_var_path = '/domains/{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] || 'Domain'

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

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

#domains_create(domain_create_params, opts = {}) ⇒ Domain

Create a domain Provision a domain by capability. A sending domain registers a cold/SMTP mailbox domain (normally born automatically when you connect a mailbox); a monitoring domain starts DMARC monitoring and auto-mints its first collection address (read it back with find?expand=collectionAddresses). The common manual use is adding an external monitor-only domain.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



91
92
93
94
 
# File 'lib/norbelys/api/domains_api.rb', line 91

def domains_create(domain_create_params, opts = {})
  data, _status_code, _headers = domains_create_with_http_info(domain_create_params, opts)
  data
end

#domains_create_with_http_info(domain_create_params, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Create a domain Provision a domain by capability. A `sending` domain registers a cold/SMTP mailbox domain (normally born automatically when you connect a mailbox); a `monitoring` domain starts DMARC monitoring and auto-mints its first collection address (read it back with find?expand=collectionAddresses). The common manual use is adding an external monitor-only domain.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    Domain data, response status code and response headers



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

def domains_create_with_http_info(domain_create_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_create ...'
  end
  # verify the required parameter 'domain_create_params' is set
  if @api_client.config.client_side_validation && domain_create_params.nil?
    fail ArgumentError, "Missing the required parameter 'domain_create_params' when calling DomainsApi.domains_create"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling DomainsApi.domains_create, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/domains'

  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#domains_find(id, opts = {}) ⇒ DomainDetail

Get a domain Read one domain (a monitoring domain reports its DMARC collection readiness on read). Pass expand=collectionAddresses to inline the rua addresses reports are sent to.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



166
167
168
169
 
# File 'lib/norbelys/api/domains_api.rb', line 166

def domains_find(id, opts = {})
  data, _status_code, _headers = domains_find_with_http_info(id, opts)
  data
end

#domains_find_with_http_info(id, opts = {}) ⇒ Array<(DomainDetail, Integer, Hash)>

Get a domain Read one domain (a monitoring domain reports its DMARC collection readiness on read). Pass expand=collectionAddresses to inline the rua addresses reports are sent to.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    DomainDetail data, response status code and response headers



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
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/norbelys/api/domains_api.rb', line 177

def domains_find_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_find ...'
  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 DomainsApi.domains_find"
  end
  allowable_values = ["collectionAddresses", "trackingDomains"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !opts[:'expand'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"expand\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].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] || 'DomainDetail'

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

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

#domains_list(opts = {}) ⇒ DomainList

List domains List your domains — both sending domains and DMARC-monitoring domains. Filter by capability, or pass programId to scope to the sending domains a campaign sends from (adds senderCount).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :include_archived (Boolean)
  • :limit (Integer)
  • :capability (String)
  • :program_id (String)

Returns:



239
240
241
242
 
# File 'lib/norbelys/api/domains_api.rb', line 239

def domains_list(opts = {})
  data, _status_code, _headers = domains_list_with_http_info(opts)
  data
end

#domains_list_with_http_info(opts = {}) ⇒ Array<(DomainList, Integer, Hash)>

List domains List your domains — both sending domains and DMARC-monitoring domains. Filter by capability, or pass programId to scope to the sending domains a campaign sends from (adds senderCount).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :include_archived (Boolean)
  • :limit (Integer)
  • :capability (String)
  • :program_id (String)

Returns:

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

    DomainList data, response status code and response headers



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/norbelys/api/domains_api.rb', line 253

def domains_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DomainsApi.domains_list, must be smaller than or equal to 100.'
  end

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

  allowable_values = ["sending", "monitoring", "tracking"]
  if @api_client.config.client_side_validation && opts[:'capability'] && !allowable_values.include?(opts[:'capability'])
    fail ArgumentError, "invalid value for \"capability\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/domains'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'capability'] = opts[:'capability'] if !opts[:'capability'].nil?
  query_params[:'programId'] = opts[:'program_id'] if !opts[:'program_id'].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] || 'DomainList'

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

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

#domains_restore(id, opts = {}) ⇒ Domain

Restore an archived domain Un-archive a domain. A monitoring domain also resumes DMARC report collection (its collection addresses are re-enabled).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



320
321
322
323
 
# File 'lib/norbelys/api/domains_api.rb', line 320

def domains_restore(id, opts = {})
  data, _status_code, _headers = domains_restore_with_http_info(id, opts)
  data
end

#domains_restore_with_http_info(id, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Restore an archived domain Un-archive a domain. A monitoring domain also resumes DMARC report collection (its collection addresses are re-enabled).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    Domain data, response status code and response headers



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/norbelys/api/domains_api.rb', line 331

def domains_restore_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_restore ...'
  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 DomainsApi.domains_restore"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling DomainsApi.domains_restore, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/domains/{id}/restore'.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']
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#domains_share(id, opts = {}) ⇒ ReportShare

Share the DMARC report Mint a public, read-only link to this monitoring domain's DMARC report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the domain kills it immediately. Mint again for a fresh link.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



390
391
392
393
 
# File 'lib/norbelys/api/domains_api.rb', line 390

def domains_share(id, opts = {})
  data, _status_code, _headers = domains_share_with_http_info(id, opts)
  data
end

#domains_share_with_http_info(id, opts = {}) ⇒ Array<(ReportShare, Integer, Hash)>

Share the DMARC report Mint a public, read-only link to this monitoring domain's DMARC report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the domain kills it immediately. Mint again for a fresh link.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    ReportShare data, response status code and response headers



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/norbelys/api/domains_api.rb', line 401

def domains_share_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_share ...'
  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 DomainsApi.domains_share"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling DomainsApi.domains_share, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/domains/{id}/share'.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']
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#domains_update(id, domain_update_params, opts = {}) ⇒ Domain

Update a domain Update customer-owned settings on a sending or tracking domain. Operational DNS, TLS, health, recommendation, and capacity fields are read-only. The required version provides optimistic concurrency.

Parameters:

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

    the optional parameters

Returns:



460
461
462
463
 
# File 'lib/norbelys/api/domains_api.rb', line 460

def domains_update(id, domain_update_params, opts = {})
  data, _status_code, _headers = domains_update_with_http_info(id, domain_update_params, opts)
  data
end

#domains_update_with_http_info(id, domain_update_params, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Update a domain Update customer-owned settings on a sending or tracking domain. Operational DNS, TLS, health, recommendation, and capacity fields are read-only. The required version provides optimistic concurrency.

Parameters:

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

    the optional parameters

Returns:

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

    Domain data, response status code and response headers



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/norbelys/api/domains_api.rb', line 471

def domains_update_with_http_info(id, domain_update_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_update ...'
  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 DomainsApi.domains_update"
  end
  # verify the required parameter 'domain_update_params' is set
  if @api_client.config.client_side_validation && domain_update_params.nil?
    fail ArgumentError, "Missing the required parameter 'domain_update_params' when calling DomainsApi.domains_update"
  end
  # resource path
  local_var_path = '/domains/{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']
  # 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(domain_update_params)

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

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

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