Class: Lockally::MigrationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/api/migrations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MigrationsApi

Returns a new instance of MigrationsApi.



19
20
21
 
# File 'lib/lockally/api/migrations_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/lockally/api/migrations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_migration(id, opts = {}) ⇒ DiscoverMigration202Response

Cancel a running migration

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/lockally/api/migrations_api.rb', line 26

def cancel_migration(id, opts = {})
  data, _status_code, _headers = cancel_migration_with_http_info(id, opts)
  data
end

#cancel_migration_with_http_info(id, opts = {}) ⇒ Array<(DiscoverMigration202Response, Integer, Hash)>

Cancel a running migration

Parameters:

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

    the optional parameters

Returns:



35
36
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
 
# File 'lib/lockally/api/migrations_api.rb', line 35

def cancel_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.cancel_migration ...'
  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 MigrationsApi.cancel_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/cancel'.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', 'application/problem+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] || 'DiscoverMigration202Response'

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

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

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

Check DNS readiness for cutover

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


87
88
89
90
 
# File 'lib/lockally/api/migrations_api.rb', line 87

def check_migration_dns(id, opts = {})
  data, _status_code, _headers = check_migration_dns_with_http_info(id, opts)
  data
end

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

Check DNS readiness for cutover

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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

def check_migration_dns_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.check_migration_dns ...'
  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 MigrationsApi.check_migration_dns"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/dns-check'.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', 'application/problem+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] || ['bearerAuth']

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

#create_migration(create_migration_request, opts = {}) ⇒ Migration

Create a migration

Parameters:

Returns:



148
149
150
151
 
# File 'lib/lockally/api/migrations_api.rb', line 148

def create_migration(create_migration_request, opts = {})
  data, _status_code, _headers = create_migration_with_http_info(create_migration_request, opts)
  data
end

#create_migration_credential(create_migration_credential_request, opts = {}) ⇒ MigrationCredential

Store a migration credential

Parameters:

Returns:



214
215
216
217
 
# File 'lib/lockally/api/migrations_api.rb', line 214

def create_migration_credential(create_migration_credential_request, opts = {})
  data, _status_code, _headers = create_migration_credential_with_http_info(create_migration_credential_request, opts)
  data
end

#create_migration_credential_with_http_info(create_migration_credential_request, opts = {}) ⇒ Array<(MigrationCredential, Integer, Hash)>

Store a migration credential

Parameters:

Returns:

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

    MigrationCredential data, response status code and response headers



223
224
225
226
227
228
229
230
231
232
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
 
# File 'lib/lockally/api/migrations_api.rb', line 223

def create_migration_credential_with_http_info(create_migration_credential_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.create_migration_credential ...'
  end
  # verify the required parameter 'create_migration_credential_request' is set
  if @api_client.config.client_side_validation && create_migration_credential_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_migration_credential_request' when calling MigrationsApi.create_migration_credential"
  end
  # resource path
  local_var_path = '/v1/migrations/credentials'

  # 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', 'application/problem+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(create_migration_credential_request)

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

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

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

#create_migration_with_http_info(create_migration_request, opts = {}) ⇒ Array<(Migration, Integer, Hash)>

Create a migration

Parameters:

Returns:

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

    Migration data, response status code and response headers



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

def create_migration_with_http_info(create_migration_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.create_migration ...'
  end
  # verify the required parameter 'create_migration_request' is set
  if @api_client.config.client_side_validation && create_migration_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_migration_request' when calling MigrationsApi.create_migration"
  end
  # resource path
  local_var_path = '/v1/migrations'

  # 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', 'application/problem+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(create_migration_request)

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

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

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

#delete_migration(id, opts = {}) ⇒ nil

Delete a migration

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


280
281
282
283
 
# File 'lib/lockally/api/migrations_api.rb', line 280

def delete_migration(id, opts = {})
  delete_migration_with_http_info(id, opts)
  nil
end

#delete_migration_credential(id, opts = {}) ⇒ nil

Delete a migration credential

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


341
342
343
344
 
# File 'lib/lockally/api/migrations_api.rb', line 341

def delete_migration_credential(id, opts = {})
  delete_migration_credential_with_http_info(id, opts)
  nil
end

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

Delete a migration credential

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/lockally/api/migrations_api.rb', line 350

def delete_migration_credential_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.delete_migration_credential ...'
  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 MigrationsApi.delete_migration_credential"
  end
  # resource path
  local_var_path = '/v1/migrations/credentials/{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/problem+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] || ['bearerAuth']

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

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

Delete a migration

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/lockally/api/migrations_api.rb', line 289

def delete_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.delete_migration ...'
  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 MigrationsApi.delete_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{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/problem+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] || ['bearerAuth']

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

#delta_sync_migration(id, opts = {}) ⇒ StartMigration202Response

Run a delta sync

Parameters:

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

    the optional parameters

Returns:



402
403
404
405
 
# File 'lib/lockally/api/migrations_api.rb', line 402

def delta_sync_migration(id, opts = {})
  data, _status_code, _headers = delta_sync_migration_with_http_info(id, opts)
  data
end

#delta_sync_migration_with_http_info(id, opts = {}) ⇒ Array<(StartMigration202Response, Integer, Hash)>

Run a delta sync

Parameters:

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

    the optional parameters

Returns:

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

    StartMigration202Response data, response status code and response headers



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
453
454
455
456
457
 
# File 'lib/lockally/api/migrations_api.rb', line 411

def delta_sync_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.delta_sync_migration ...'
  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 MigrationsApi.delta_sync_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/delta-sync'.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', 'application/problem+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] || 'StartMigration202Response'

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

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

#discover_migration(id, opts = {}) ⇒ DiscoverMigration202Response

Discover source mailboxes

Parameters:

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

    the optional parameters

Returns:



463
464
465
466
 
# File 'lib/lockally/api/migrations_api.rb', line 463

def discover_migration(id, opts = {})
  data, _status_code, _headers = discover_migration_with_http_info(id, opts)
  data
end

#discover_migration_with_http_info(id, opts = {}) ⇒ Array<(DiscoverMigration202Response, Integer, Hash)>

Discover source mailboxes

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/lockally/api/migrations_api.rb', line 472

def discover_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.discover_migration ...'
  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 MigrationsApi.discover_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/discover'.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', 'application/problem+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] || 'DiscoverMigration202Response'

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

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

#final_sync_migration(id, opts = {}) ⇒ StartMigration202Response

Run the final sync before cutover

Parameters:

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

    the optional parameters

Returns:



524
525
526
527
 
# File 'lib/lockally/api/migrations_api.rb', line 524

def final_sync_migration(id, opts = {})
  data, _status_code, _headers = final_sync_migration_with_http_info(id, opts)
  data
end

#final_sync_migration_with_http_info(id, opts = {}) ⇒ Array<(StartMigration202Response, Integer, Hash)>

Run the final sync before cutover

Parameters:

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

    the optional parameters

Returns:

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

    StartMigration202Response data, response status code and response headers



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/lockally/api/migrations_api.rb', line 533

def final_sync_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.final_sync_migration ...'
  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 MigrationsApi.final_sync_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/final-sync'.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', 'application/problem+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] || 'StartMigration202Response'

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

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

#get_migration(id, opts = {}) ⇒ Migration

Get a migration

Parameters:

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

    the optional parameters

Returns:



585
586
587
588
 
# File 'lib/lockally/api/migrations_api.rb', line 585

def get_migration(id, opts = {})
  data, _status_code, _headers = get_migration_with_http_info(id, opts)
  data
end

#get_migration_progress(id, opts = {}) ⇒ MigrationProgress

Get migration progress

Parameters:

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

    the optional parameters

Returns:



646
647
648
649
 
# File 'lib/lockally/api/migrations_api.rb', line 646

def get_migration_progress(id, opts = {})
  data, _status_code, _headers = get_migration_progress_with_http_info(id, opts)
  data
end

#get_migration_progress_with_http_info(id, opts = {}) ⇒ Array<(MigrationProgress, Integer, Hash)>

Get migration progress

Parameters:

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

    the optional parameters

Returns:

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

    MigrationProgress data, response status code and response headers



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/lockally/api/migrations_api.rb', line 655

def get_migration_progress_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.get_migration_progress ...'
  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 MigrationsApi.get_migration_progress"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/progress'.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', 'application/problem+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] || 'MigrationProgress'

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

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

#get_migration_with_http_info(id, opts = {}) ⇒ Array<(Migration, Integer, Hash)>

Get a migration

Parameters:

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

    the optional parameters

Returns:

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

    Migration data, response status code and response headers



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/lockally/api/migrations_api.rb', line 594

def get_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.get_migration ...'
  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 MigrationsApi.get_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{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', 'application/problem+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] || 'Migration'

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

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

#list_migration_credentials(opts = {}) ⇒ ListMigrationCredentials200Response

List migration credentials

Parameters:

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

    the optional parameters

Returns:



706
707
708
709
 
# File 'lib/lockally/api/migrations_api.rb', line 706

def list_migration_credentials(opts = {})
  data, _status_code, _headers = list_migration_credentials_with_http_info(opts)
  data
end

#list_migration_credentials_with_http_info(opts = {}) ⇒ Array<(ListMigrationCredentials200Response, Integer, Hash)>

List migration credentials

Parameters:

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

    the optional parameters

Returns:



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/lockally/api/migrations_api.rb', line 714

def list_migration_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.list_migration_credentials ...'
  end
  # resource path
  local_var_path = '/v1/migrations/credentials'

  # 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', 'application/problem+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] || 'ListMigrationCredentials200Response'

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

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

#list_migration_events(id, opts = {}) ⇒ ListMigrationEvents200Response

List migration events

Parameters:

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

    the optional parameters

Returns:



762
763
764
765
 
# File 'lib/lockally/api/migrations_api.rb', line 762

def list_migration_events(id, opts = {})
  data, _status_code, _headers = list_migration_events_with_http_info(id, opts)
  data
end

#list_migration_events_with_http_info(id, opts = {}) ⇒ Array<(ListMigrationEvents200Response, Integer, Hash)>

List migration events

Parameters:

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

    the optional parameters

Returns:



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/lockally/api/migrations_api.rb', line 771

def list_migration_events_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.list_migration_events ...'
  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 MigrationsApi.list_migration_events"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/events'.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', 'application/problem+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] || 'ListMigrationEvents200Response'

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

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

#list_migration_mailboxes(id, opts = {}) ⇒ ListMigrationMailboxes200Response

List migration mailboxes

Parameters:

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

    the optional parameters

Returns:



823
824
825
826
 
# File 'lib/lockally/api/migrations_api.rb', line 823

def list_migration_mailboxes(id, opts = {})
  data, _status_code, _headers = list_migration_mailboxes_with_http_info(id, opts)
  data
end

#list_migration_mailboxes_with_http_info(id, opts = {}) ⇒ Array<(ListMigrationMailboxes200Response, Integer, Hash)>

List migration mailboxes

Parameters:

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

    the optional parameters

Returns:



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/lockally/api/migrations_api.rb', line 832

def list_migration_mailboxes_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.list_migration_mailboxes ...'
  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 MigrationsApi.list_migration_mailboxes"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/mailboxes'.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', 'application/problem+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] || 'ListMigrationMailboxes200Response'

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

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

#list_migrations(opts = {}) ⇒ ListMigrations200Response

List migrations

Parameters:

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

    the optional parameters

Returns:



883
884
885
886
 
# File 'lib/lockally/api/migrations_api.rb', line 883

def list_migrations(opts = {})
  data, _status_code, _headers = list_migrations_with_http_info(opts)
  data
end

#list_migrations_with_http_info(opts = {}) ⇒ Array<(ListMigrations200Response, Integer, Hash)>

List migrations

Parameters:

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

    the optional parameters

Returns:

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

    ListMigrations200Response data, response status code and response headers



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/lockally/api/migrations_api.rb', line 891

def list_migrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.list_migrations ...'
  end
  # resource path
  local_var_path = '/v1/migrations'

  # 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', 'application/problem+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] || 'ListMigrations200Response'

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

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

#map_migration(id, map_migration_request, opts = {}) ⇒ DiscoverMigration202Response

Map source to destination mailboxes

Parameters:

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

    the optional parameters

Returns:



940
941
942
943
 
# File 'lib/lockally/api/migrations_api.rb', line 940

def map_migration(id, map_migration_request, opts = {})
  data, _status_code, _headers = map_migration_with_http_info(id, map_migration_request, opts)
  data
end

#map_migration_with_http_info(id, map_migration_request, opts = {}) ⇒ Array<(DiscoverMigration202Response, Integer, Hash)>

Map source to destination mailboxes

Parameters:

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

    the optional parameters

Returns:



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/lockally/api/migrations_api.rb', line 950

def map_migration_with_http_info(id, map_migration_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.map_migration ...'
  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 MigrationsApi.map_migration"
  end
  # verify the required parameter 'map_migration_request' is set
  if @api_client.config.client_side_validation && map_migration_request.nil?
    fail ArgumentError, "Missing the required parameter 'map_migration_request' when calling MigrationsApi.map_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/map'.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', 'application/problem+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(map_migration_request)

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

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

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

#retry_migration(id, opts = {}) ⇒ DiscoverMigration202Response

Retry a failed or cancelled migration

Parameters:

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

    the optional parameters

Returns:



1011
1012
1013
1014
 
# File 'lib/lockally/api/migrations_api.rb', line 1011

def retry_migration(id, opts = {})
  data, _status_code, _headers = retry_migration_with_http_info(id, opts)
  data
end

#retry_migration_with_http_info(id, opts = {}) ⇒ Array<(DiscoverMigration202Response, Integer, Hash)>

Retry a failed or cancelled migration

Parameters:

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

    the optional parameters

Returns:



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/lockally/api/migrations_api.rb', line 1020

def retry_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.retry_migration ...'
  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 MigrationsApi.retry_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/retry'.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', 'application/problem+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] || 'DiscoverMigration202Response'

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

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

#start_migration(id, opts = {}) ⇒ StartMigration202Response

Start the migration

Parameters:

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

    the optional parameters

Returns:



1072
1073
1074
1075
 
# File 'lib/lockally/api/migrations_api.rb', line 1072

def start_migration(id, opts = {})
  data, _status_code, _headers = start_migration_with_http_info(id, opts)
  data
end

#start_migration_with_http_info(id, opts = {}) ⇒ Array<(StartMigration202Response, Integer, Hash)>

Start the migration

Parameters:

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

    the optional parameters

Returns:

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

    StartMigration202Response data, response status code and response headers



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'lib/lockally/api/migrations_api.rb', line 1081

def start_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.start_migration ...'
  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 MigrationsApi.start_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/start'.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', 'application/problem+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] || 'StartMigration202Response'

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

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

#update_migration(id, update_migration_request, opts = {}) ⇒ Migration

Update a migration

Parameters:

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

    the optional parameters

Returns:



1134
1135
1136
1137
 
# File 'lib/lockally/api/migrations_api.rb', line 1134

def update_migration(id, update_migration_request, opts = {})
  data, _status_code, _headers = update_migration_with_http_info(id, update_migration_request, opts)
  data
end

#update_migration_mailbox(id, mbx_id, update_migration_mailbox_request, opts = {}) ⇒ nil

Update a migration mailbox

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1207
1208
1209
1210
 
# File 'lib/lockally/api/migrations_api.rb', line 1207

def update_migration_mailbox(id, mbx_id, update_migration_mailbox_request, opts = {})
  update_migration_mailbox_with_http_info(id, mbx_id, update_migration_mailbox_request, opts)
  nil
end

#update_migration_mailbox_with_http_info(id, mbx_id, update_migration_mailbox_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a migration mailbox

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
 
# File 'lib/lockally/api/migrations_api.rb', line 1218

def update_migration_mailbox_with_http_info(id, mbx_id, update_migration_mailbox_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.update_migration_mailbox ...'
  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 MigrationsApi.update_migration_mailbox"
  end
  # verify the required parameter 'mbx_id' is set
  if @api_client.config.client_side_validation && mbx_id.nil?
    fail ArgumentError, "Missing the required parameter 'mbx_id' when calling MigrationsApi.update_migration_mailbox"
  end
  # verify the required parameter 'update_migration_mailbox_request' is set
  if @api_client.config.client_side_validation && update_migration_mailbox_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_migration_mailbox_request' when calling MigrationsApi.update_migration_mailbox"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/mailboxes/{mbxId}'.sub('{id}', CGI.escape(id.to_s)).sub('{mbxId}', CGI.escape(mbx_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/problem+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(update_migration_mailbox_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_migration_with_http_info(id, update_migration_request, opts = {}) ⇒ Array<(Migration, Integer, Hash)>

Update a migration

Parameters:

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

    the optional parameters

Returns:

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

    Migration data, response status code and response headers



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/lockally/api/migrations_api.rb', line 1144

def update_migration_with_http_info(id, update_migration_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.update_migration ...'
  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 MigrationsApi.update_migration"
  end
  # verify the required parameter 'update_migration_request' is set
  if @api_client.config.client_side_validation && update_migration_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_migration_request' when calling MigrationsApi.update_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{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', 'application/problem+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(update_migration_request)

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

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

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

#validate_migration(id, opts = {}) ⇒ StartMigration202Response

Validate migrated data

Parameters:

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

    the optional parameters

Returns:



1283
1284
1285
1286
 
# File 'lib/lockally/api/migrations_api.rb', line 1283

def validate_migration(id, opts = {})
  data, _status_code, _headers = validate_migration_with_http_info(id, opts)
  data
end

#validate_migration_with_http_info(id, opts = {}) ⇒ Array<(StartMigration202Response, Integer, Hash)>

Validate migrated data

Parameters:

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

    the optional parameters

Returns:

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

    StartMigration202Response data, response status code and response headers



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/lockally/api/migrations_api.rb', line 1292

def validate_migration_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationsApi.validate_migration ...'
  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 MigrationsApi.validate_migration"
  end
  # resource path
  local_var_path = '/v1/migrations/{id}/validate'.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', 'application/problem+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] || 'StartMigration202Response'

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

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