flywheel-sdk 19.3.0rc1__py2.py3-none-any.whl → 19.4.0__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
flywheel/api/files_api.py CHANGED
@@ -351,9 +351,9 @@ class FilesApi(object):
351
351
  collection_formats=collection_formats)
352
352
 
353
353
  def delete_files_by_ids(self, body, **kwargs): # noqa: E501
354
- """Delete Files by IDs
354
+ """Delete multiple files by ID list
355
355
 
356
- Delete multiple files by file ID list.
356
+ Delete multiple files by ID list
357
357
  This method makes a synchronous HTTP request by default.
358
358
 
359
359
  :param list[str] body: List of IDs to delete (required)
@@ -378,9 +378,9 @@ class FilesApi(object):
378
378
 
379
379
 
380
380
  def delete_files_by_ids_with_http_info(self, body, **kwargs): # noqa: E501
381
- """Delete Files by IDs
381
+ """Delete multiple files by ID list
382
382
 
383
- Delete multiple files by file ID list.
383
+ Delete multiple files by ID list
384
384
  This method makes a synchronous HTTP request by default.
385
385
 
386
386
  :param list[str] body: List of IDs to delete (required)
@@ -454,6 +454,110 @@ class FilesApi(object):
454
454
  _request_out=params.get('_request_out'),
455
455
  collection_formats=collection_formats)
456
456
 
457
+ def delete_files_by_query(self, body, **kwargs): # noqa: E501
458
+ """Delete multiple files by query
459
+
460
+ Delete multiple files by query
461
+ This method makes a synchronous HTTP request by default.
462
+
463
+ :param list[Filter] body: Query for containers to delete (required)
464
+ :param ContainerDeleteReason delete_reason:
465
+ :param bool async_: Perform the request asynchronously
466
+ :return: DeletedResult
467
+ """
468
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
469
+ kwargs['_return_http_data_only'] = True
470
+
471
+ if kwargs.get('async_'):
472
+ return self.delete_files_by_query_with_http_info(body, **kwargs) # noqa: E501
473
+ else:
474
+ (data) = self.delete_files_by_query_with_http_info(body, **kwargs) # noqa: E501
475
+ if (
476
+ data
477
+ and hasattr(data, 'return_value')
478
+ and not ignore_simplified_return_value
479
+ ):
480
+ return data.return_value()
481
+ return data
482
+
483
+
484
+ def delete_files_by_query_with_http_info(self, body, **kwargs): # noqa: E501
485
+ """Delete multiple files by query
486
+
487
+ Delete multiple files by query
488
+ This method makes a synchronous HTTP request by default.
489
+
490
+ :param list[Filter] body: Query for containers to delete (required)
491
+ :param ContainerDeleteReason delete_reason:
492
+ :param bool async_: Perform the request asynchronously
493
+ :return: DeletedResult
494
+ """
495
+
496
+ all_params = ['body','delete_reason',] # noqa: E501
497
+ all_params.append('async_')
498
+ all_params.append('_return_http_data_only')
499
+ all_params.append('_preload_content')
500
+ all_params.append('_request_timeout')
501
+ all_params.append('_request_out')
502
+
503
+ params = locals()
504
+ for key, val in six.iteritems(params['kwargs']):
505
+ if key not in all_params:
506
+ raise TypeError(
507
+ "Got an unexpected keyword argument '%s'"
508
+ " to method delete_files_by_query" % key
509
+ )
510
+ params[key] = val
511
+ del params['kwargs']
512
+ # verify the required parameter 'body' is set
513
+ if ('body' not in params or
514
+ params['body'] is None):
515
+ raise ValueError("Missing the required parameter `body` when calling `delete_files_by_query`") # noqa: E501
516
+
517
+ collection_formats = {}
518
+
519
+ path_params = {}
520
+
521
+ query_params = []
522
+ if 'delete_reason' in params:
523
+ query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
524
+
525
+ header_params = {}
526
+
527
+ form_params = []
528
+ local_var_files = {}
529
+
530
+ body_params = None
531
+ if 'body' in params:
532
+ body_params = params['body']
533
+ # HTTP header `Accept`
534
+ header_params['Accept'] = self.api_client.select_header_accept(
535
+ ['application/json']) # noqa: E501
536
+
537
+ # HTTP header `Content-Type`
538
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
539
+ ['application/json']) # noqa: E501
540
+
541
+ # Authentication setting
542
+ auth_settings = ['ApiKey'] # noqa: E501
543
+
544
+ return self.api_client.call_api(
545
+ '/files/delete_by_query', 'DELETE',
546
+ path_params,
547
+ query_params,
548
+ header_params,
549
+ body=body_params,
550
+ post_params=form_params,
551
+ files=local_var_files,
552
+ response_type='DeletedResult', # noqa: E501
553
+ auth_settings=auth_settings,
554
+ async_=params.get('async_'),
555
+ _return_http_data_only=params.get('_return_http_data_only'),
556
+ _preload_content=params.get('_preload_content', True),
557
+ _request_timeout=params.get('_request_timeout'),
558
+ _request_out=params.get('_request_out'),
559
+ collection_formats=collection_formats)
560
+
457
561
  def get_all_files(self, **kwargs): # noqa: E501
458
562
  """Return all files
459
563
 
@@ -862,6 +966,110 @@ class FilesApi(object):
862
966
  _request_out=params.get('_request_out'),
863
967
  collection_formats=collection_formats)
864
968
 
969
+ def get_file_zip_info(self, file_id, **kwargs): # noqa: E501
970
+ """Get Zip Info
971
+
972
+ Get info on zipfile
973
+ This method makes a synchronous HTTP request by default.
974
+
975
+ :param str file_id: (required)
976
+ :param int version:
977
+ :param str ticket:
978
+ :param bool async_: Perform the request asynchronously
979
+ :return: ZipfileInfo
980
+ """
981
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
982
+ kwargs['_return_http_data_only'] = True
983
+
984
+ if kwargs.get('async_'):
985
+ return self.get_file_zip_info_with_http_info(file_id, **kwargs) # noqa: E501
986
+ else:
987
+ (data) = self.get_file_zip_info_with_http_info(file_id, **kwargs) # noqa: E501
988
+ if (
989
+ data
990
+ and hasattr(data, 'return_value')
991
+ and not ignore_simplified_return_value
992
+ ):
993
+ return data.return_value()
994
+ return data
995
+
996
+
997
+ def get_file_zip_info_with_http_info(self, file_id, **kwargs): # noqa: E501
998
+ """Get Zip Info
999
+
1000
+ Get info on zipfile
1001
+ This method makes a synchronous HTTP request by default.
1002
+
1003
+ :param str file_id: (required)
1004
+ :param int version:
1005
+ :param str ticket:
1006
+ :param bool async_: Perform the request asynchronously
1007
+ :return: ZipfileInfo
1008
+ """
1009
+
1010
+ all_params = ['file_id','version','ticket',] # noqa: E501
1011
+ all_params.append('async_')
1012
+ all_params.append('_return_http_data_only')
1013
+ all_params.append('_preload_content')
1014
+ all_params.append('_request_timeout')
1015
+ all_params.append('_request_out')
1016
+
1017
+ params = locals()
1018
+ for key, val in six.iteritems(params['kwargs']):
1019
+ if key not in all_params:
1020
+ raise TypeError(
1021
+ "Got an unexpected keyword argument '%s'"
1022
+ " to method get_file_zip_info" % key
1023
+ )
1024
+ params[key] = val
1025
+ del params['kwargs']
1026
+ # verify the required parameter 'file_id' is set
1027
+ if ('file_id' not in params or
1028
+ params['file_id'] is None):
1029
+ raise ValueError("Missing the required parameter `file_id` when calling `get_file_zip_info`") # noqa: E501
1030
+
1031
+ collection_formats = {}
1032
+
1033
+ path_params = {}
1034
+ if 'file_id' in params:
1035
+ path_params['file_id'] = params['file_id'] # noqa: E501
1036
+
1037
+ query_params = []
1038
+ if 'version' in params:
1039
+ query_params.append(('version', params['version'])) # noqa: E501
1040
+ if 'ticket' in params:
1041
+ query_params.append(('ticket', params['ticket'])) # noqa: E501
1042
+
1043
+ header_params = {}
1044
+
1045
+ form_params = []
1046
+ local_var_files = {}
1047
+
1048
+ body_params = None
1049
+ # HTTP header `Accept`
1050
+ header_params['Accept'] = self.api_client.select_header_accept(
1051
+ ['application/json']) # noqa: E501
1052
+
1053
+ # Authentication setting
1054
+ auth_settings = ['ApiKey'] # noqa: E501
1055
+
1056
+ return self.api_client.call_api(
1057
+ '/files/{file_id}/zip_info', 'GET',
1058
+ path_params,
1059
+ query_params,
1060
+ header_params,
1061
+ body=body_params,
1062
+ post_params=form_params,
1063
+ files=local_var_files,
1064
+ response_type='ZipfileInfo', # noqa: E501
1065
+ auth_settings=auth_settings,
1066
+ async_=params.get('async_'),
1067
+ _return_http_data_only=params.get('_return_http_data_only'),
1068
+ _preload_content=params.get('_preload_content', True),
1069
+ _request_timeout=params.get('_request_timeout'),
1070
+ _request_out=params.get('_request_out'),
1071
+ collection_formats=collection_formats)
1072
+
865
1073
  def move_file(self, file_id, body, **kwargs): # noqa: E501
866
1074
  """Move and/or rename a file
867
1075
 
@@ -1343,6 +1343,110 @@ class GroupsApi(object):
1343
1343
  _request_out=params.get('_request_out'),
1344
1344
  collection_formats=collection_formats)
1345
1345
 
1346
+ def delete_groups_by_query(self, body, **kwargs): # noqa: E501
1347
+ """Delete multiple groups by query
1348
+
1349
+ Delete multiple groups by query
1350
+ This method makes a synchronous HTTP request by default.
1351
+
1352
+ :param list[Filter] body: Query for containers to delete (required)
1353
+ :param ContainerDeleteReason delete_reason:
1354
+ :param bool async_: Perform the request asynchronously
1355
+ :return: DeletedResult
1356
+ """
1357
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1358
+ kwargs['_return_http_data_only'] = True
1359
+
1360
+ if kwargs.get('async_'):
1361
+ return self.delete_groups_by_query_with_http_info(body, **kwargs) # noqa: E501
1362
+ else:
1363
+ (data) = self.delete_groups_by_query_with_http_info(body, **kwargs) # noqa: E501
1364
+ if (
1365
+ data
1366
+ and hasattr(data, 'return_value')
1367
+ and not ignore_simplified_return_value
1368
+ ):
1369
+ return data.return_value()
1370
+ return data
1371
+
1372
+
1373
+ def delete_groups_by_query_with_http_info(self, body, **kwargs): # noqa: E501
1374
+ """Delete multiple groups by query
1375
+
1376
+ Delete multiple groups by query
1377
+ This method makes a synchronous HTTP request by default.
1378
+
1379
+ :param list[Filter] body: Query for containers to delete (required)
1380
+ :param ContainerDeleteReason delete_reason:
1381
+ :param bool async_: Perform the request asynchronously
1382
+ :return: DeletedResult
1383
+ """
1384
+
1385
+ all_params = ['body','delete_reason',] # noqa: E501
1386
+ all_params.append('async_')
1387
+ all_params.append('_return_http_data_only')
1388
+ all_params.append('_preload_content')
1389
+ all_params.append('_request_timeout')
1390
+ all_params.append('_request_out')
1391
+
1392
+ params = locals()
1393
+ for key, val in six.iteritems(params['kwargs']):
1394
+ if key not in all_params:
1395
+ raise TypeError(
1396
+ "Got an unexpected keyword argument '%s'"
1397
+ " to method delete_groups_by_query" % key
1398
+ )
1399
+ params[key] = val
1400
+ del params['kwargs']
1401
+ # verify the required parameter 'body' is set
1402
+ if ('body' not in params or
1403
+ params['body'] is None):
1404
+ raise ValueError("Missing the required parameter `body` when calling `delete_groups_by_query`") # noqa: E501
1405
+
1406
+ collection_formats = {}
1407
+
1408
+ path_params = {}
1409
+
1410
+ query_params = []
1411
+ if 'delete_reason' in params:
1412
+ query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
1413
+
1414
+ header_params = {}
1415
+
1416
+ form_params = []
1417
+ local_var_files = {}
1418
+
1419
+ body_params = None
1420
+ if 'body' in params:
1421
+ body_params = params['body']
1422
+ # HTTP header `Accept`
1423
+ header_params['Accept'] = self.api_client.select_header_accept(
1424
+ ['application/json']) # noqa: E501
1425
+
1426
+ # HTTP header `Content-Type`
1427
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
1428
+ ['application/json']) # noqa: E501
1429
+
1430
+ # Authentication setting
1431
+ auth_settings = ['ApiKey'] # noqa: E501
1432
+
1433
+ return self.api_client.call_api(
1434
+ '/groups/delete_by_query', 'DELETE',
1435
+ path_params,
1436
+ query_params,
1437
+ header_params,
1438
+ body=body_params,
1439
+ post_params=form_params,
1440
+ files=local_var_files,
1441
+ response_type='DeletedResult', # noqa: E501
1442
+ auth_settings=auth_settings,
1443
+ async_=params.get('async_'),
1444
+ _return_http_data_only=params.get('_return_http_data_only'),
1445
+ _preload_content=params.get('_preload_content', True),
1446
+ _request_timeout=params.get('_request_timeout'),
1447
+ _request_out=params.get('_request_out'),
1448
+ collection_formats=collection_formats)
1449
+
1346
1450
  def get_all_group_roles(self, group_id, **kwargs): # noqa: E501
1347
1451
  """Get list of group roles
1348
1452
 
@@ -1664,6 +1768,7 @@ class GroupsApi(object):
1664
1768
 
1665
1769
  :param str group_id: (required)
1666
1770
  :param bool exhaustive:
1771
+ :param bool include_all_info: Include all info in returned objects
1667
1772
  :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
1668
1773
  :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1669
1774
  :param int limit: The maximum number of entries to return.
@@ -1698,6 +1803,7 @@ class GroupsApi(object):
1698
1803
 
1699
1804
  :param str group_id: (required)
1700
1805
  :param bool exhaustive:
1806
+ :param bool include_all_info: Include all info in returned objects
1701
1807
  :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
1702
1808
  :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1703
1809
  :param int limit: The maximum number of entries to return.
@@ -1709,7 +1815,7 @@ class GroupsApi(object):
1709
1815
  :return: union[Page,list[ProjectListOutput]]
1710
1816
  """
1711
1817
 
1712
- all_params = ['group_id','exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
1818
+ all_params = ['group_id','exhaustive','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
1713
1819
  all_params.append('async_')
1714
1820
  all_params.append('_return_http_data_only')
1715
1821
  all_params.append('_preload_content')
@@ -1739,6 +1845,8 @@ class GroupsApi(object):
1739
1845
  query_params = []
1740
1846
  if 'exhaustive' in params:
1741
1847
  query_params.append(('exhaustive', params['exhaustive'])) # noqa: E501
1848
+ if 'include_all_info' in params:
1849
+ query_params.append(('include_all_info', params['include_all_info'])) # noqa: E501
1742
1850
  if 'filter' in params:
1743
1851
  query_params.append(('filter', params['filter'])) # noqa: E501
1744
1852
  if 'sort' in params:
flywheel/api/jobs_api.py CHANGED
@@ -699,6 +699,7 @@ class JobsApi(object):
699
699
  :param int page: The page number (i.e. skip limit*page entries)
700
700
  :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
701
701
  :param bool include_parent_info: Include the parent info for the jobs
702
+ :param bool include_all_info: Include all info in returned objects
702
703
  :param list[str] x_accept_feature:
703
704
  :param bool async_: Perform the request asynchronously
704
705
  :return: union[list[JobListOutput],Page]
@@ -731,12 +732,13 @@ class JobsApi(object):
731
732
  :param int page: The page number (i.e. skip limit*page entries)
732
733
  :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
733
734
  :param bool include_parent_info: Include the parent info for the jobs
735
+ :param bool include_all_info: Include all info in returned objects
734
736
  :param list[str] x_accept_feature:
735
737
  :param bool async_: Perform the request asynchronously
736
738
  :return: union[list[JobListOutput],Page]
737
739
  """
738
740
 
739
- all_params = ['filter','sort','limit','skip','page','after_id','include_parent_info','x_accept_feature',] # noqa: E501
741
+ all_params = ['filter','sort','limit','skip','page','after_id','include_parent_info','include_all_info','x_accept_feature',] # noqa: E501
740
742
  all_params.append('async_')
741
743
  all_params.append('_return_http_data_only')
742
744
  all_params.append('_preload_content')
@@ -772,6 +774,8 @@ class JobsApi(object):
772
774
  query_params.append(('after_id', params['after_id'])) # noqa: E501
773
775
  if 'include_parent_info' in params:
774
776
  query_params.append(('include_parent_info', params['include_parent_info'])) # noqa: E501
777
+ if 'include_all_info' in params:
778
+ query_params.append(('include_all_info', params['include_all_info'])) # noqa: E501
775
779
 
776
780
  header_params = {}
777
781
  if 'x_accept_feature' in params: