flywheel-sdk 19.2.0__py2.py3-none-any.whl → 19.3.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/flywheel.py CHANGED
@@ -40,7 +40,7 @@ from flywheel.view_builder import ViewBuilder
40
40
  from flywheel.finder import Finder
41
41
  import flywheel.api
42
42
 
43
- SDK_VERSION = "19.2.0"
43
+ SDK_VERSION = "19.3.0"
44
44
 
45
45
  def config_from_api_key(api_key):
46
46
  parts = api_key.split(':')
@@ -221,8 +221,9 @@ class Flywheel:
221
221
 
222
222
 
223
223
  def add_acquisition_analysis_note(self, container_id, analysis_id, body, **kwargs): # noqa: E501
224
- """Add a note to acquisition analysis.
224
+ """Add a note to a(n) acquisition analysis.
225
225
 
226
+ Add a note to a(n) acquisition analysis.
226
227
 
227
228
  :param str container_id: 24-char hex id (required)
228
229
  :param str analysis_id: 24-char hex analysis id (required)
@@ -234,8 +235,9 @@ class Flywheel:
234
235
 
235
236
 
236
237
  def add_acquisition_note(self, container_id, body, **kwargs): # noqa: E501
237
- """Add a note to acquisition.
238
+ """Add a note to a(n) acquisition.
238
239
 
240
+ Add a note to a(n) acquisition.
239
241
 
240
242
  :param str container_id: (required)
241
243
  :param NoteInput body: (required)
@@ -246,7 +248,7 @@ class Flywheel:
246
248
 
247
249
 
248
250
  def add_acquisition_tag(self, cid, body, **kwargs): # noqa: E501
249
- """Add a tag to acquisition.
251
+ """Add a tag to a(n) acquisition.
250
252
 
251
253
  Propagates changes to projects, sessions and acquisitions
252
254
 
@@ -259,9 +261,9 @@ class Flywheel:
259
261
 
260
262
 
261
263
  def add_acquisition_tags(self, cid, body, **kwargs): # noqa: E501
262
- """Add multiple tags to acquisition
264
+ """Add multiple tags to a(n) acquisition
263
265
 
264
- Add multiple tags to acquisition
266
+ Add multiple tags to a(n) acquisition
265
267
 
266
268
  :param str cid: (required)
267
269
  :param list[str] body: (required)
@@ -285,7 +287,7 @@ class Flywheel:
285
287
 
286
288
 
287
289
  def delete_acquisition_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
288
- """Delete an anaylsis
290
+ """Delete an analysis
289
291
 
290
292
  Delete an analysis for a container.
291
293
 
@@ -299,9 +301,9 @@ class Flywheel:
299
301
 
300
302
 
301
303
  def delete_acquisition_analysis_note(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
302
- """Remove a note from acquisition analysis.
304
+ """Remove a note from a(n) acquisition analysis.
303
305
 
304
- Remove a note from acquisition analysis.
306
+ Remove a note from a(n) acquisition analysis.
305
307
 
306
308
  :param str cid: 24-char hex id (required)
307
309
  :param str analysis_id: 24-char hex analysis id (required)
@@ -328,9 +330,9 @@ class Flywheel:
328
330
 
329
331
 
330
332
  def delete_acquisition_note(self, cid, note_id, **kwargs): # noqa: E501
331
- """Remove a note from acquisition
333
+ """Remove a note from a(n) acquisition
332
334
 
333
- Remove a note from acquisition
335
+ Remove a note from a(n) acquisition
334
336
 
335
337
  :param str cid: (required)
336
338
  :param str note_id: (required)
@@ -354,9 +356,9 @@ class Flywheel:
354
356
 
355
357
 
356
358
  def delete_acquisition_tags(self, cid, body, **kwargs): # noqa: E501
357
- """Delete multiple tags from acquisition
359
+ """Delete multiple tags from a(n) acquisition
358
360
 
359
- Delete multiple tags from acquisition
361
+ Delete multiple tags from a(n) acquisition
360
362
 
361
363
  :param str cid: (required)
362
364
  :param list[str] body: (required)
@@ -366,12 +368,25 @@ class Flywheel:
366
368
  return self.acquisitions_api.delete_acquisition_tags(cid, body, **kwargs)
367
369
 
368
370
 
371
+ def delete_acquisitions_by_ids(self, body, **kwargs): # noqa: E501
372
+ """Delete multiple acquisitions by ID list
373
+
374
+ Delete multiple acquisitions by ID list
375
+
376
+ :param list[str] body: List of IDs to delete (required)
377
+ :param ContainerDeleteReason delete_reason:
378
+ :param bool async_: Perform the request asynchronously
379
+ :return: DeletedResult
380
+ """
381
+ return self.acquisitions_api.delete_acquisitions_by_ids(body, **kwargs)
382
+
383
+
369
384
  def download_file_from_acquisition(self, acquisition_id, file_name, dest_file, **kwargs): # noqa: E501
370
385
  """Download a file.
371
386
 
372
387
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
373
388
 
374
- :param str acquisition_id: 24-char hex id (required)
389
+ :param str acquisition_id: 24-character hex ID (required)
375
390
  :param str file_name: output file name (required)
376
391
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
377
392
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -392,7 +407,7 @@ class Flywheel:
392
407
 
393
408
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
394
409
 
395
- :param str acquisition_id: 24-char hex id (required)
410
+ :param str acquisition_id: 24-character hex ID (required)
396
411
  :param str file_name: output file name (required)
397
412
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
398
413
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -413,7 +428,7 @@ class Flywheel:
413
428
 
414
429
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
415
430
 
416
- :param str acquisition_id: 24-char hex id (required)
431
+ :param str acquisition_id: 24-character hex ID (required)
417
432
  :param str file_name: output file name (required)
418
433
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
419
434
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -580,7 +595,7 @@ class Flywheel:
580
595
 
581
596
 
582
597
  def get_acquisition_analyses(self, cid, **kwargs): # noqa: E501
583
- """Get analyses for acquisition.
598
+ """Get analyses for a(n) acquisition.
584
599
 
585
600
  Returns analyses that directly belong to this resource.
586
601
 
@@ -622,7 +637,7 @@ class Flywheel:
622
637
 
623
638
  Get info for a particular file.
624
639
 
625
- :param str cid: (required)
640
+ :param str cid: Container Id (required)
626
641
  :param str filename: (required)
627
642
  :param bool async_: Perform the request asynchronously
628
643
  :return: FileOutput
@@ -631,9 +646,9 @@ class Flywheel:
631
646
 
632
647
 
633
648
  def get_acquisition_note(self, cid, note_id, **kwargs): # noqa: E501
634
- """Get a note on acquisition.
649
+ """Get a note of a(n) acquisition.
635
650
 
636
- Get a note on acquisition
651
+ Get a note of a(n) acquisition
637
652
 
638
653
  :param str cid: (required)
639
654
  :param str note_id: (required)
@@ -748,9 +763,9 @@ class Flywheel:
748
763
 
749
764
 
750
765
  def modify_acquisition_info(self, cid, body, **kwargs): # noqa: E501
751
- """Update or replace info for a acquisition.
766
+ """Update or replace info for a(n) acquisition.
752
767
 
753
- Update or replace info for a acquisition.
768
+ Update or replace info for a(n) acquisition.
754
769
 
755
770
  :param str cid: (required)
756
771
  :param Info body: (required)
@@ -761,9 +776,9 @@ class Flywheel:
761
776
 
762
777
 
763
778
  def modify_acquisition_note(self, cid, note_id, body, **kwargs): # noqa: E501
764
- """Update a note on acquisition.
779
+ """Update a note of a(n) acquisition.
765
780
 
766
- Update a note on acquisition
781
+ Update a note of a(n) acquisition
767
782
 
768
783
  :param str cid: (required)
769
784
  :param str note_id: (required)
@@ -789,8 +804,9 @@ class Flywheel:
789
804
 
790
805
 
791
806
  def upload_file_to_acquisition(self, container_id, file, signed=True, **kwargs): # noqa: E501
792
- """Upload a file to acquisition.
807
+ """Upload a file to a(n) acquisition.
793
808
 
809
+ Upload a file to a(n) acquisition.
794
810
 
795
811
  :param str container_id: (required)
796
812
  :param str file: The file to upload (required)
@@ -814,9 +830,9 @@ class Flywheel:
814
830
 
815
831
 
816
832
  def upload_output_to_acquisition_analysis(self, cid, analysis_id, file, signed=True, **kwargs): # noqa: E501
817
- """Upload an output file to analysis.
833
+ """Upload an output file to an analysis.
818
834
 
819
- Upload an output file to analysis
835
+ Upload an output file to an analysis
820
836
 
821
837
  :param str cid: (required)
822
838
  :param str analysis_id: (required)
@@ -838,12 +854,12 @@ class Flywheel:
838
854
 
839
855
 
840
856
  def add_analysis_note(self, container_id, body, **kwargs): # noqa: E501
841
- """Add a note to analysis.
857
+ """Add a note to a(n) analysis.
842
858
 
843
- Add a note to analysis.
859
+ Add a note to a(n) analysis.
844
860
 
845
- :param str container_id: Container id (required)
846
- :param NoteInput body: note content (required)
861
+ :param str container_id: (required)
862
+ :param NoteInput body: (required)
847
863
  :param bool async_: Perform the request asynchronously
848
864
  :return: Note
849
865
  """
@@ -851,7 +867,7 @@ class Flywheel:
851
867
 
852
868
 
853
869
  def add_analysis_tag(self, container_id, body, **kwargs): # noqa: E501
854
- """Add a tag to analysis.
870
+ """Add a tag to a(n) analysis.
855
871
 
856
872
  Propagates changes to projects, sessions and acquisitions
857
873
 
@@ -863,6 +879,19 @@ class Flywheel:
863
879
  return self.analyses_api.add_analysis_tag(container_id, body, **kwargs)
864
880
 
865
881
 
882
+ def delete_analyses_by_ids(self, body, **kwargs): # noqa: E501
883
+ """Delete multiple analyses by ID list
884
+
885
+ Delete analyses by id Args: analysis_ids: The ids of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when audit-trail is enabled)
886
+
887
+ :param list[str] body: List of IDs to delete (required)
888
+ :param ContainerDeleteReason delete_reason:
889
+ :param bool async_: Perform the request asynchronously
890
+ :return: DeletedResult
891
+ """
892
+ return self.analyses_api.delete_analyses_by_ids(body, **kwargs)
893
+
894
+
866
895
  def delete_analysis(self, analysis_id, **kwargs): # noqa: E501
867
896
  """Delete an analysis
868
897
 
@@ -877,14 +906,14 @@ class Flywheel:
877
906
 
878
907
 
879
908
  def delete_analysis_note(self, container_id, note_id, **kwargs): # noqa: E501
880
- """Remove a note from analysis
909
+ """Remove a note from a(n) analysis
881
910
 
882
- Remove a note from analysis
911
+ Remove a note from a(n) analysis
883
912
 
884
- :param str container_id: Container id (required)
885
- :param str note_id: 24-char hex note id (required)
913
+ :param str container_id: (required)
914
+ :param str note_id: (required)
886
915
  :param bool async_: Perform the request asynchronously
887
- :return: None
916
+ :return: DeletedResult
888
917
  """
889
918
  return self.analyses_api.delete_analysis_note(container_id, note_id, **kwargs)
890
919
 
@@ -897,7 +926,7 @@ class Flywheel:
897
926
  :param str container_id: (required)
898
927
  :param str value: The tag to interact with (required)
899
928
  :param bool async_: Perform the request asynchronously
900
- :return: None
929
+ :return: DeletedResult
901
930
  """
902
931
  return self.analyses_api.delete_analysis_tag(container_id, value, **kwargs)
903
932
 
@@ -969,7 +998,7 @@ class Flywheel:
969
998
 
970
999
  Get Output File
971
1000
 
972
- :param str analysis_id: 24-character hex ID (required)
1001
+ :param str analysis_id: Container ID (required)
973
1002
  :param str filename: output file name (required)
974
1003
  :param bool info: get file info only
975
1004
  :param str member: get zipfile member
@@ -988,7 +1017,7 @@ class Flywheel:
988
1017
 
989
1018
  Get Output File
990
1019
 
991
- :param str analysis_id: 24-character hex ID (required)
1020
+ :param str analysis_id: Container ID (required)
992
1021
  :param str filename: output file name (required)
993
1022
  :param str ticket: 24-char hex ticket id
994
1023
  :param bool info: get file info only
@@ -1007,7 +1036,7 @@ class Flywheel:
1007
1036
 
1008
1037
  Get Output File
1009
1038
 
1010
- :param str analysis_id: 24-character hex ID (required)
1039
+ :param str analysis_id: Container ID (required)
1011
1040
  :param str filename: output file name (required)
1012
1041
  :param str ticket: 24-char hex ticket id
1013
1042
  :param bool info: get file info only
@@ -1079,8 +1108,8 @@ class Flywheel:
1079
1108
 
1080
1109
  Get info for a particular file.
1081
1110
 
1082
- :param str container_id: Container id (required)
1083
- :param str filename: The name of the file (required)
1111
+ :param str container_id: Container Id (required)
1112
+ :param str filename: (required)
1084
1113
  :param bool async_: Perform the request asynchronously
1085
1114
  :return: FileOutput
1086
1115
  """
@@ -1088,12 +1117,12 @@ class Flywheel:
1088
1117
 
1089
1118
 
1090
1119
  def get_analysis_note(self, container_id, note_id, **kwargs): # noqa: E501
1091
- """Get a note on analysis.
1120
+ """Get a note of a(n) analysis.
1092
1121
 
1093
- Get a note on analysis
1122
+ Get a note of a(n) analysis
1094
1123
 
1095
- :param str container_id: Container id (required)
1096
- :param str note_id: 24-char hex note id (required)
1124
+ :param str container_id: (required)
1125
+ :param str note_id: (required)
1097
1126
  :param bool async_: Perform the request asynchronously
1098
1127
  :return: Note
1099
1128
  """
@@ -1127,9 +1156,9 @@ class Flywheel:
1127
1156
 
1128
1157
 
1129
1158
  def modify_analysis_info(self, container_id, body, **kwargs): # noqa: E501
1130
- """Update or replace info for a analysis.
1159
+ """Update or replace info for a(n) analysis.
1131
1160
 
1132
- Update or replace info for a analysis.
1161
+ Update or replace info for a(n) analysis.
1133
1162
 
1134
1163
  :param str container_id: (required)
1135
1164
  :param Info body: (required)
@@ -1140,13 +1169,13 @@ class Flywheel:
1140
1169
 
1141
1170
 
1142
1171
  def modify_analysis_note(self, container_id, note_id, body, **kwargs): # noqa: E501
1143
- """Update a note on analysis.
1172
+ """Update a note of a(n) analysis.
1144
1173
 
1145
- Update a note on analysis
1174
+ Update a note of a(n) analysis
1146
1175
 
1147
- :param str container_id: Container id (required)
1148
- :param str note_id: 24-char hex note id (required)
1149
- :param NoteInput body: note content (required)
1176
+ :param str container_id: (required)
1177
+ :param str note_id: (required)
1178
+ :param NoteInput body: (required)
1150
1179
  :param bool async_: Perform the request asynchronously
1151
1180
  :return: int
1152
1181
  """
@@ -1168,9 +1197,9 @@ class Flywheel:
1168
1197
 
1169
1198
 
1170
1199
  def upload_output_to_analysis(self, container_id, file, signed=True, **kwargs): # noqa: E501
1171
- """Upload an output file to analysis.
1200
+ """Upload an output file to an analysis.
1172
1201
 
1173
- Upload an output file to analysis
1202
+ Upload an output file to an analysis
1174
1203
 
1175
1204
  :param str container_id: (required)
1176
1205
  :param str file: The file to upload (required)
@@ -1393,8 +1422,9 @@ class Flywheel:
1393
1422
 
1394
1423
 
1395
1424
  def add_collection_note(self, container_id, body, **kwargs): # noqa: E501
1396
- """Add a note to collection.
1425
+ """Add a note to a(n) collection.
1397
1426
 
1427
+ Add a note to a(n) collection.
1398
1428
 
1399
1429
  :param str container_id: (required)
1400
1430
  :param NoteInput body: (required)
@@ -1418,7 +1448,7 @@ class Flywheel:
1418
1448
 
1419
1449
 
1420
1450
  def add_collection_tag(self, cid, body, **kwargs): # noqa: E501
1421
- """Add a tag to collection.
1451
+ """Add a tag to a(n) collection.
1422
1452
 
1423
1453
  Propagates changes to projects, sessions and acquisitions
1424
1454
 
@@ -1431,9 +1461,9 @@ class Flywheel:
1431
1461
 
1432
1462
 
1433
1463
  def add_collection_tags(self, cid, body, **kwargs): # noqa: E501
1434
- """Add multiple tags to collection
1464
+ """Add multiple tags to a(n) collection
1435
1465
 
1436
- Add multiple tags to collection
1466
+ Add multiple tags to a(n) collection
1437
1467
 
1438
1468
  :param str cid: (required)
1439
1469
  :param list[str] body: (required)
@@ -1471,9 +1501,9 @@ class Flywheel:
1471
1501
 
1472
1502
 
1473
1503
  def delete_collection_note(self, cid, note_id, **kwargs): # noqa: E501
1474
- """Remove a note from collection
1504
+ """Remove a note from a(n) collection
1475
1505
 
1476
- Remove a note from collection
1506
+ Remove a note from a(n) collection
1477
1507
 
1478
1508
  :param str cid: (required)
1479
1509
  :param str note_id: (required)
@@ -1497,9 +1527,9 @@ class Flywheel:
1497
1527
 
1498
1528
 
1499
1529
  def delete_collection_tags(self, cid, body, **kwargs): # noqa: E501
1500
- """Delete multiple tags from collection
1530
+ """Delete multiple tags from a(n) collection
1501
1531
 
1502
- Delete multiple tags from collection
1532
+ Delete multiple tags from a(n) collection
1503
1533
 
1504
1534
  :param str cid: (required)
1505
1535
  :param list[str] body: (required)
@@ -1522,12 +1552,25 @@ class Flywheel:
1522
1552
  return self.collections_api.delete_collection_user_permission(collection_id, user_id, **kwargs)
1523
1553
 
1524
1554
 
1555
+ def delete_collections_by_ids(self, body, **kwargs): # noqa: E501
1556
+ """Delete multiple collections by ID list
1557
+
1558
+ Delete multiple collections by ID list
1559
+
1560
+ :param list[str] body: List of IDs to delete (required)
1561
+ :param ContainerDeleteReason delete_reason:
1562
+ :param bool async_: Perform the request asynchronously
1563
+ :return: DeletedResult
1564
+ """
1565
+ return self.collections_api.delete_collections_by_ids(body, **kwargs)
1566
+
1567
+
1525
1568
  def download_file_from_collection(self, collection_id, file_name, dest_file, **kwargs): # noqa: E501
1526
1569
  """Download a file.
1527
1570
 
1528
1571
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
1529
1572
 
1530
- :param str collection_id: 24-char hex id (required)
1573
+ :param str collection_id: 24-character hex ID (required)
1531
1574
  :param str file_name: output file name (required)
1532
1575
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
1533
1576
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -1548,7 +1591,7 @@ class Flywheel:
1548
1591
 
1549
1592
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
1550
1593
 
1551
- :param str collection_id: 24-char hex id (required)
1594
+ :param str collection_id: 24-character hex ID (required)
1552
1595
  :param str file_name: output file name (required)
1553
1596
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1554
1597
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -1569,7 +1612,7 @@ class Flywheel:
1569
1612
 
1570
1613
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
1571
1614
 
1572
- :param str collection_id: 24-char hex id (required)
1615
+ :param str collection_id: 24-character hex ID (required)
1573
1616
  :param str file_name: output file name (required)
1574
1617
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1575
1618
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -1671,7 +1714,7 @@ class Flywheel:
1671
1714
 
1672
1715
  Get info for a particular file.
1673
1716
 
1674
- :param str cid: (required)
1717
+ :param str cid: Container Id (required)
1675
1718
  :param str filename: (required)
1676
1719
  :param bool async_: Perform the request asynchronously
1677
1720
  :return: FileOutput
@@ -1680,9 +1723,9 @@ class Flywheel:
1680
1723
 
1681
1724
 
1682
1725
  def get_collection_note(self, cid, note_id, **kwargs): # noqa: E501
1683
- """Get a note on collection.
1726
+ """Get a note of a(n) collection.
1684
1727
 
1685
- Get a note on collection
1728
+ Get a note of a(n) collection
1686
1729
 
1687
1730
  :param str cid: (required)
1688
1731
  :param str note_id: (required)
@@ -1793,9 +1836,9 @@ class Flywheel:
1793
1836
 
1794
1837
 
1795
1838
  def modify_collection_info(self, cid, body, **kwargs): # noqa: E501
1796
- """Update or replace info for a collection.
1839
+ """Update or replace info for a(n) collection.
1797
1840
 
1798
- Update or replace info for a collection.
1841
+ Update or replace info for a(n) collection.
1799
1842
 
1800
1843
  :param str cid: (required)
1801
1844
  :param Info body: (required)
@@ -1806,9 +1849,9 @@ class Flywheel:
1806
1849
 
1807
1850
 
1808
1851
  def modify_collection_note(self, cid, note_id, body, **kwargs): # noqa: E501
1809
- """Update a note on collection.
1852
+ """Update a note of a(n) collection.
1810
1853
 
1811
- Update a note on collection
1854
+ Update a note of a(n) collection
1812
1855
 
1813
1856
  :param str cid: (required)
1814
1857
  :param str note_id: (required)
@@ -1848,8 +1891,9 @@ class Flywheel:
1848
1891
 
1849
1892
 
1850
1893
  def upload_file_to_collection(self, container_id, file, signed=True, **kwargs): # noqa: E501
1851
- """Upload a file to collection.
1894
+ """Upload a file to a(n) collection.
1852
1895
 
1896
+ Upload a file to a(n) collection.
1853
1897
 
1854
1898
  :param str container_id: (required)
1855
1899
  :param str file: The file to upload (required)
@@ -1921,8 +1965,9 @@ class Flywheel:
1921
1965
 
1922
1966
 
1923
1967
  def add_container_analysis_note(self, container_id, analysis_id, body, **kwargs): # noqa: E501
1924
- """Add a note to container analysis.
1968
+ """Add a note to a(n) container analysis.
1925
1969
 
1970
+ Add a note to a(n) container analysis.
1926
1971
 
1927
1972
  :param str container_id: 24-char hex id (required)
1928
1973
  :param str analysis_id: 24-char hex analysis id (required)
@@ -1934,8 +1979,9 @@ class Flywheel:
1934
1979
 
1935
1980
 
1936
1981
  def add_container_note(self, container_id, body, **kwargs): # noqa: E501
1937
- """Add a note to container.
1982
+ """Add a note to a(n) container.
1938
1983
 
1984
+ Add a note to a(n) container.
1939
1985
 
1940
1986
  :param str container_id: (required)
1941
1987
  :param NoteInput body: (required)
@@ -1946,7 +1992,7 @@ class Flywheel:
1946
1992
 
1947
1993
 
1948
1994
  def add_container_tag(self, cid, body, **kwargs): # noqa: E501
1949
- """Add a tag to container.
1995
+ """Add a tag to a(n) container.
1950
1996
 
1951
1997
  Propagates changes to projects, sessions and acquisitions
1952
1998
 
@@ -1959,9 +2005,9 @@ class Flywheel:
1959
2005
 
1960
2006
 
1961
2007
  def add_container_tags(self, cid, body, **kwargs): # noqa: E501
1962
- """Add multiple tags to container
2008
+ """Add multiple tags to a(n) container
1963
2009
 
1964
- Add multiple tags to container
2010
+ Add multiple tags to a(n) container
1965
2011
 
1966
2012
  :param str cid: (required)
1967
2013
  :param list[str] body: (required)
@@ -1998,7 +2044,7 @@ class Flywheel:
1998
2044
 
1999
2045
 
2000
2046
  def delete_container_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
2001
- """Delete an anaylsis
2047
+ """Delete an analysis
2002
2048
 
2003
2049
  Delete an analysis for a container.
2004
2050
 
@@ -2012,9 +2058,9 @@ class Flywheel:
2012
2058
 
2013
2059
 
2014
2060
  def delete_container_analysis_note(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
2015
- """Remove a note from container analysis.
2061
+ """Remove a note from a(n) container analysis.
2016
2062
 
2017
- Remove a note from container analysis.
2063
+ Remove a note from a(n) container analysis.
2018
2064
 
2019
2065
  :param str cid: 24-char hex id (required)
2020
2066
  :param str analysis_id: 24-char hex analysis id (required)
@@ -2041,9 +2087,9 @@ class Flywheel:
2041
2087
 
2042
2088
 
2043
2089
  def delete_container_note(self, cid, note_id, **kwargs): # noqa: E501
2044
- """Remove a note from container
2090
+ """Remove a note from a(n) container
2045
2091
 
2046
- Remove a note from container
2092
+ Remove a note from a(n) container
2047
2093
 
2048
2094
  :param str cid: (required)
2049
2095
  :param str note_id: (required)
@@ -2067,9 +2113,9 @@ class Flywheel:
2067
2113
 
2068
2114
 
2069
2115
  def delete_container_tags(self, cid, body, **kwargs): # noqa: E501
2070
- """Delete multiple tags from container
2116
+ """Delete multiple tags from a(n) container
2071
2117
 
2072
- Delete multiple tags from container
2118
+ Delete multiple tags from a(n) container
2073
2119
 
2074
2120
  :param str cid: (required)
2075
2121
  :param list[str] body: (required)
@@ -2084,7 +2130,7 @@ class Flywheel:
2084
2130
 
2085
2131
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
2086
2132
 
2087
- :param str container_id: 24-char hex id (required)
2133
+ :param str container_id: 24-character hex ID (required)
2088
2134
  :param str file_name: output file name (required)
2089
2135
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
2090
2136
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -2105,7 +2151,7 @@ class Flywheel:
2105
2151
 
2106
2152
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
2107
2153
 
2108
- :param str container_id: 24-char hex id (required)
2154
+ :param str container_id: 24-character hex ID (required)
2109
2155
  :param str file_name: output file name (required)
2110
2156
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2111
2157
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -2126,7 +2172,7 @@ class Flywheel:
2126
2172
 
2127
2173
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
2128
2174
 
2129
- :param str container_id: 24-char hex id (required)
2175
+ :param str container_id: 24-character hex ID (required)
2130
2176
  :param str file_name: output file name (required)
2131
2177
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2132
2178
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -2292,7 +2338,7 @@ class Flywheel:
2292
2338
 
2293
2339
 
2294
2340
  def get_container_analyses(self, cid, **kwargs): # noqa: E501
2295
- """Get analyses for container.
2341
+ """Get analyses for a(n) container.
2296
2342
 
2297
2343
  Returns analyses that directly belong to this resource.
2298
2344
 
@@ -2334,7 +2380,7 @@ class Flywheel:
2334
2380
 
2335
2381
  Get info for a particular file.
2336
2382
 
2337
- :param str cid: (required)
2383
+ :param str cid: Container Id (required)
2338
2384
  :param str filename: (required)
2339
2385
  :param bool async_: Perform the request asynchronously
2340
2386
  :return: FileOutput
@@ -2343,9 +2389,9 @@ class Flywheel:
2343
2389
 
2344
2390
 
2345
2391
  def get_container_note(self, cid, note_id, **kwargs): # noqa: E501
2346
- """Get a note on container.
2392
+ """Get a note of a(n) container.
2347
2393
 
2348
- Get a note on container
2394
+ Get a note of a(n) container
2349
2395
 
2350
2396
  :param str cid: (required)
2351
2397
  :param str note_id: (required)
@@ -2456,9 +2502,9 @@ class Flywheel:
2456
2502
 
2457
2503
 
2458
2504
  def modify_container_info(self, cid, body, **kwargs): # noqa: E501
2459
- """Update or replace info for a container.
2505
+ """Update or replace info for a(n) container.
2460
2506
 
2461
- Update or replace info for a container.
2507
+ Update or replace info for a(n) container.
2462
2508
 
2463
2509
  :param str cid: (required)
2464
2510
  :param Info body: (required)
@@ -2469,9 +2515,9 @@ class Flywheel:
2469
2515
 
2470
2516
 
2471
2517
  def modify_container_note(self, cid, note_id, body, **kwargs): # noqa: E501
2472
- """Update a note on container.
2518
+ """Update a note of a(n) container.
2473
2519
 
2474
- Update a note on container
2520
+ Update a note of a(n) container
2475
2521
 
2476
2522
  :param str cid: (required)
2477
2523
  :param str note_id: (required)
@@ -2497,8 +2543,9 @@ class Flywheel:
2497
2543
 
2498
2544
 
2499
2545
  def upload_file_to_container(self, container_id, file, signed=True, **kwargs): # noqa: E501
2500
- """Upload a file to container.
2546
+ """Upload a file to a(n) container.
2501
2547
 
2548
+ Upload a file to a(n) container.
2502
2549
 
2503
2550
  :param str container_id: (required)
2504
2551
  :param str file: The file to upload (required)
@@ -2522,9 +2569,9 @@ class Flywheel:
2522
2569
 
2523
2570
 
2524
2571
  def upload_output_to_container_analysis(self, cid, analysis_id, file, signed=True, **kwargs): # noqa: E501
2525
- """Upload an output file to analysis.
2572
+ """Upload an output file to an analysis.
2526
2573
 
2527
- Upload an output file to analysis
2574
+ Upload an output file to an analysis
2528
2575
 
2529
2576
  :param str cid: (required)
2530
2577
  :param str analysis_id: (required)
@@ -3015,6 +3062,19 @@ class Flywheel:
3015
3062
  return self.files_api.delete_file_tags(file_id, **kwargs)
3016
3063
 
3017
3064
 
3065
+ def delete_files_by_ids(self, body, **kwargs): # noqa: E501
3066
+ """Delete Files by IDs
3067
+
3068
+ Delete multiple files by file ID list.
3069
+
3070
+ :param list[str] body: List of IDs to delete (required)
3071
+ :param ContainerDeleteReason delete_reason:
3072
+ :param bool async_: Perform the request asynchronously
3073
+ :return: DeletedResult
3074
+ """
3075
+ return self.files_api.delete_files_by_ids(body, **kwargs)
3076
+
3077
+
3018
3078
  def get_all_files(self, **kwargs): # noqa: E501
3019
3079
  """Return all files
3020
3080
 
@@ -3386,7 +3446,7 @@ class Flywheel:
3386
3446
 
3387
3447
 
3388
3448
  def add_group_tag(self, cid, body, **kwargs): # noqa: E501
3389
- """Add a tag to group.
3449
+ """Add a tag to a(n) group.
3390
3450
 
3391
3451
  Propagates changes to projects, sessions and acquisitions
3392
3452
 
@@ -3399,9 +3459,9 @@ class Flywheel:
3399
3459
 
3400
3460
 
3401
3461
  def add_group_tags(self, cid, body, **kwargs): # noqa: E501
3402
- """Add multiple tags to group
3462
+ """Add multiple tags to a(n) group
3403
3463
 
3404
- Add multiple tags to group
3464
+ Add multiple tags to a(n) group
3405
3465
 
3406
3466
  :param str cid: (required)
3407
3467
  :param list[str] body: (required)
@@ -3450,9 +3510,9 @@ class Flywheel:
3450
3510
 
3451
3511
 
3452
3512
  def delete_group_tags(self, cid, body, **kwargs): # noqa: E501
3453
- """Delete tags
3513
+ """Delete multiple tags from a(n) group
3454
3514
 
3455
- Delete tags
3515
+ Delete multiple tags from a(n) group
3456
3516
 
3457
3517
  :param str cid: (required)
3458
3518
  :param list[str] body: (required)
@@ -3490,6 +3550,19 @@ class Flywheel:
3490
3550
  return self.groups_api.delete_group_user_permission_template(group_id, user_id, **kwargs)
3491
3551
 
3492
3552
 
3553
+ def delete_groups_by_ids(self, body, **kwargs): # noqa: E501
3554
+ """Delete multiple groups by ID list
3555
+
3556
+ Delete multiple groups by ID list
3557
+
3558
+ :param list[str] body: List of IDs to delete (required)
3559
+ :param ContainerDeleteReason delete_reason:
3560
+ :param bool async_: Perform the request asynchronously
3561
+ :return: DeletedResult
3562
+ """
3563
+ return self.groups_api.delete_groups_by_ids(body, **kwargs)
3564
+
3565
+
3493
3566
  def get_all_group_roles(self, group_id, **kwargs): # noqa: E501
3494
3567
  """Get list of group roles
3495
3568
 
@@ -4033,8 +4106,9 @@ class Flywheel:
4033
4106
 
4034
4107
 
4035
4108
  def add_project_analysis_note(self, container_id, analysis_id, body, **kwargs): # noqa: E501
4036
- """Add a note to project analysis.
4109
+ """Add a note to a(n) project analysis.
4037
4110
 
4111
+ Add a note to a(n) project analysis.
4038
4112
 
4039
4113
  :param str container_id: 24-char hex id (required)
4040
4114
  :param str analysis_id: 24-char hex analysis id (required)
@@ -4046,8 +4120,9 @@ class Flywheel:
4046
4120
 
4047
4121
 
4048
4122
  def add_project_note(self, container_id, body, **kwargs): # noqa: E501
4049
- """Add a note to project.
4123
+ """Add a note to a(n) project.
4050
4124
 
4125
+ Add a note to a(n) project.
4051
4126
 
4052
4127
  :param str container_id: (required)
4053
4128
  :param NoteInput body: (required)
@@ -4084,7 +4159,7 @@ class Flywheel:
4084
4159
 
4085
4160
 
4086
4161
  def add_project_tag(self, cid, body, **kwargs): # noqa: E501
4087
- """Add a tag to project.
4162
+ """Add a tag to a(n) project.
4088
4163
 
4089
4164
  Propagates changes to projects, sessions and acquisitions
4090
4165
 
@@ -4097,9 +4172,9 @@ class Flywheel:
4097
4172
 
4098
4173
 
4099
4174
  def add_project_tags(self, cid, body, **kwargs): # noqa: E501
4100
- """Add multiple tags to project
4175
+ """Add multiple tags to a(n) project
4101
4176
 
4102
- Add multiple tags to project
4177
+ Add multiple tags to a(n) project
4103
4178
 
4104
4179
  :param str cid: (required)
4105
4180
  :param list[str] body: (required)
@@ -4141,7 +4216,7 @@ class Flywheel:
4141
4216
 
4142
4217
 
4143
4218
  def delete_project_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
4144
- """Delete an anaylsis
4219
+ """Delete an analysis
4145
4220
 
4146
4221
  Delete an analysis for a container.
4147
4222
 
@@ -4155,9 +4230,9 @@ class Flywheel:
4155
4230
 
4156
4231
 
4157
4232
  def delete_project_analysis_note(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
4158
- """Remove a note from project analysis.
4233
+ """Remove a note from a(n) project analysis.
4159
4234
 
4160
- Remove a note from project analysis.
4235
+ Remove a note from a(n) project analysis.
4161
4236
 
4162
4237
  :param str cid: 24-char hex id (required)
4163
4238
  :param str analysis_id: 24-char hex analysis id (required)
@@ -4184,9 +4259,9 @@ class Flywheel:
4184
4259
 
4185
4260
 
4186
4261
  def delete_project_note(self, cid, note_id, **kwargs): # noqa: E501
4187
- """Remove a note from project
4262
+ """Remove a note from a(n) project
4188
4263
 
4189
- Remove a note from project
4264
+ Remove a note from a(n) project
4190
4265
 
4191
4266
  :param str cid: (required)
4192
4267
  :param str note_id: (required)
@@ -4210,9 +4285,9 @@ class Flywheel:
4210
4285
 
4211
4286
 
4212
4287
  def delete_project_tags(self, cid, body, **kwargs): # noqa: E501
4213
- """Delete multiple tags from project
4288
+ """Delete multiple tags from a(n) project
4214
4289
 
4215
- Delete multiple tags from project
4290
+ Delete multiple tags from a(n) project
4216
4291
 
4217
4292
  :param str cid: (required)
4218
4293
  :param list[str] body: (required)
@@ -4235,12 +4310,25 @@ class Flywheel:
4235
4310
  return self.projects_api.delete_project_user_permission(project_id, uid, **kwargs)
4236
4311
 
4237
4312
 
4313
+ def delete_projects_by_ids(self, body, **kwargs): # noqa: E501
4314
+ """Delete multiple projects by ID list
4315
+
4316
+ Delete multiple projects by ID list
4317
+
4318
+ :param list[str] body: List of IDs to delete (required)
4319
+ :param ContainerDeleteReason delete_reason:
4320
+ :param bool async_: Perform the request asynchronously
4321
+ :return: DeletedResult
4322
+ """
4323
+ return self.projects_api.delete_projects_by_ids(body, **kwargs)
4324
+
4325
+
4238
4326
  def download_file_from_project(self, project_id, file_name, dest_file, **kwargs): # noqa: E501
4239
4327
  """Download a file.
4240
4328
 
4241
4329
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
4242
4330
 
4243
- :param str project_id: 24-char hex id (required)
4331
+ :param str project_id: 24-character hex ID (required)
4244
4332
  :param str file_name: output file name (required)
4245
4333
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
4246
4334
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -4261,7 +4349,7 @@ class Flywheel:
4261
4349
 
4262
4350
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
4263
4351
 
4264
- :param str project_id: 24-char hex id (required)
4352
+ :param str project_id: 24-character hex ID (required)
4265
4353
  :param str file_name: output file name (required)
4266
4354
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
4267
4355
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -4282,7 +4370,7 @@ class Flywheel:
4282
4370
 
4283
4371
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
4284
4372
 
4285
- :param str project_id: 24-char hex id (required)
4373
+ :param str project_id: 24-character hex ID (required)
4286
4374
  :param str file_name: output file name (required)
4287
4375
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
4288
4376
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -4533,7 +4621,7 @@ class Flywheel:
4533
4621
 
4534
4622
 
4535
4623
  def get_project_analyses(self, cid, **kwargs): # noqa: E501
4536
- """Get analyses for project.
4624
+ """Get analyses for a(n) project.
4537
4625
 
4538
4626
  Returns analyses that directly belong to this resource.
4539
4627
 
@@ -4575,7 +4663,7 @@ class Flywheel:
4575
4663
 
4576
4664
  Get info for a particular file.
4577
4665
 
4578
- :param str cid: (required)
4666
+ :param str cid: Container Id (required)
4579
4667
  :param str filename: (required)
4580
4668
  :param bool async_: Perform the request asynchronously
4581
4669
  :return: FileOutput
@@ -4584,9 +4672,9 @@ class Flywheel:
4584
4672
 
4585
4673
 
4586
4674
  def get_project_note(self, cid, note_id, **kwargs): # noqa: E501
4587
- """Get a note on project.
4675
+ """Get a note of a(n) project.
4588
4676
 
4589
- Get a note on project
4677
+ Get a note of a(n) project
4590
4678
 
4591
4679
  :param str cid: (required)
4592
4680
  :param str note_id: (required)
@@ -4641,9 +4729,9 @@ class Flywheel:
4641
4729
 
4642
4730
 
4643
4731
  def get_project_settings(self, project_id, **kwargs): # noqa: E501
4644
- """Get settings on project
4732
+ """Get a(n) project settings
4645
4733
 
4646
- Get settings on project
4734
+ Route for getting settings from a a(n) project
4647
4735
 
4648
4736
  :param str project_id: (required)
4649
4737
  :param bool async_: Perform the request asynchronously
@@ -4768,9 +4856,9 @@ class Flywheel:
4768
4856
 
4769
4857
 
4770
4858
  def modify_project_info(self, cid, body, **kwargs): # noqa: E501
4771
- """Update or replace info for a project.
4859
+ """Update or replace info for a(n) project.
4772
4860
 
4773
- Update or replace info for a project.
4861
+ Update or replace info for a(n) project.
4774
4862
 
4775
4863
  :param str cid: (required)
4776
4864
  :param Info body: (required)
@@ -4781,9 +4869,9 @@ class Flywheel:
4781
4869
 
4782
4870
 
4783
4871
  def modify_project_note(self, cid, note_id, body, **kwargs): # noqa: E501
4784
- """Update a note on project.
4872
+ """Update a note of a(n) project.
4785
4873
 
4786
- Update a note on project
4874
+ Update a note of a(n) project
4787
4875
 
4788
4876
  :param str cid: (required)
4789
4877
  :param str note_id: (required)
@@ -4809,9 +4897,9 @@ class Flywheel:
4809
4897
 
4810
4898
 
4811
4899
  def modify_project_settings(self, project_id, body, **kwargs): # noqa: E501
4812
- """Modify project settings
4900
+ """Modify a(n) project settings
4813
4901
 
4814
- Modify project settings
4902
+ Route for modifying settings for a a(n) project
4815
4903
 
4816
4904
  :param str project_id: (required)
4817
4905
  :param ProjectSettingsInput body: (required)
@@ -4947,8 +5035,9 @@ class Flywheel:
4947
5035
 
4948
5036
 
4949
5037
  def upload_file_to_project(self, container_id, file, signed=True, **kwargs): # noqa: E501
4950
- """Upload a file to project.
5038
+ """Upload a file to a(n) project.
4951
5039
 
5040
+ Upload a file to a(n) project.
4952
5041
 
4953
5042
  :param str container_id: (required)
4954
5043
  :param str file: The file to upload (required)
@@ -4972,9 +5061,9 @@ class Flywheel:
4972
5061
 
4973
5062
 
4974
5063
  def upload_output_to_project_analysis(self, cid, analysis_id, file, signed=True, **kwargs): # noqa: E501
4975
- """Upload an output file to analysis.
5064
+ """Upload an output file to an analysis.
4976
5065
 
4977
- Upload an output file to analysis
5066
+ Upload an output file to an analysis
4978
5067
 
4979
5068
  :param str cid: (required)
4980
5069
  :param str analysis_id: (required)
@@ -5255,8 +5344,9 @@ class Flywheel:
5255
5344
 
5256
5345
 
5257
5346
  def add_session_analysis_note(self, container_id, analysis_id, body, **kwargs): # noqa: E501
5258
- """Add a note to session analysis.
5347
+ """Add a note to a(n) session analysis.
5259
5348
 
5349
+ Add a note to a(n) session analysis.
5260
5350
 
5261
5351
  :param str container_id: 24-char hex id (required)
5262
5352
  :param str analysis_id: 24-char hex analysis id (required)
@@ -5268,8 +5358,9 @@ class Flywheel:
5268
5358
 
5269
5359
 
5270
5360
  def add_session_note(self, container_id, body, **kwargs): # noqa: E501
5271
- """Add a note to session.
5361
+ """Add a note to a(n) session.
5272
5362
 
5363
+ Add a note to a(n) session.
5273
5364
 
5274
5365
  :param str container_id: (required)
5275
5366
  :param NoteInput body: (required)
@@ -5280,7 +5371,7 @@ class Flywheel:
5280
5371
 
5281
5372
 
5282
5373
  def add_session_tag(self, cid, body, **kwargs): # noqa: E501
5283
- """Add a tag to session.
5374
+ """Add a tag to a(n) session.
5284
5375
 
5285
5376
  Propagates changes to projects, sessions and acquisitions
5286
5377
 
@@ -5293,9 +5384,9 @@ class Flywheel:
5293
5384
 
5294
5385
 
5295
5386
  def add_session_tags(self, cid, body, **kwargs): # noqa: E501
5296
- """Add multiple tags to session
5387
+ """Add multiple tags to a(n) session
5297
5388
 
5298
- Add multiple tags to session
5389
+ Add multiple tags to a(n) session
5299
5390
 
5300
5391
  :param str cid: (required)
5301
5392
  :param list[str] body: (required)
@@ -5319,7 +5410,7 @@ class Flywheel:
5319
5410
 
5320
5411
 
5321
5412
  def delete_session_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
5322
- """Delete an anaylsis
5413
+ """Delete an analysis
5323
5414
 
5324
5415
  Delete an analysis for a container.
5325
5416
 
@@ -5333,9 +5424,9 @@ class Flywheel:
5333
5424
 
5334
5425
 
5335
5426
  def delete_session_analysis_note(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
5336
- """Remove a note from session analysis.
5427
+ """Remove a note from a(n) session analysis.
5337
5428
 
5338
- Remove a note from session analysis.
5429
+ Remove a note from a(n) session analysis.
5339
5430
 
5340
5431
  :param str cid: 24-char hex id (required)
5341
5432
  :param str analysis_id: 24-char hex analysis id (required)
@@ -5362,9 +5453,9 @@ class Flywheel:
5362
5453
 
5363
5454
 
5364
5455
  def delete_session_note(self, cid, note_id, **kwargs): # noqa: E501
5365
- """Remove a note from session
5456
+ """Remove a note from a(n) session
5366
5457
 
5367
- Remove a note from session
5458
+ Remove a note from a(n) session
5368
5459
 
5369
5460
  :param str cid: (required)
5370
5461
  :param str note_id: (required)
@@ -5388,9 +5479,9 @@ class Flywheel:
5388
5479
 
5389
5480
 
5390
5481
  def delete_session_tags(self, cid, body, **kwargs): # noqa: E501
5391
- """Delete multiple tags from session
5482
+ """Delete multiple tags from a(n) session
5392
5483
 
5393
- Delete multiple tags from session
5484
+ Delete multiple tags from a(n) session
5394
5485
 
5395
5486
  :param str cid: (required)
5396
5487
  :param list[str] body: (required)
@@ -5400,12 +5491,25 @@ class Flywheel:
5400
5491
  return self.sessions_api.delete_session_tags(cid, body, **kwargs)
5401
5492
 
5402
5493
 
5494
+ def delete_sessions_by_ids(self, body, **kwargs): # noqa: E501
5495
+ """Delete multiple sessions by ID list
5496
+
5497
+ Delete multiple sessions by ID list
5498
+
5499
+ :param list[str] body: List of IDs to delete (required)
5500
+ :param ContainerDeleteReason delete_reason:
5501
+ :param bool async_: Perform the request asynchronously
5502
+ :return: DeletedResult
5503
+ """
5504
+ return self.sessions_api.delete_sessions_by_ids(body, **kwargs)
5505
+
5506
+
5403
5507
  def download_file_from_session(self, session_id, file_name, dest_file, **kwargs): # noqa: E501
5404
5508
  """Download a file.
5405
5509
 
5406
5510
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
5407
5511
 
5408
- :param str session_id: 24-char hex id (required)
5512
+ :param str session_id: 24-character hex ID (required)
5409
5513
  :param str file_name: output file name (required)
5410
5514
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
5411
5515
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -5426,7 +5530,7 @@ class Flywheel:
5426
5530
 
5427
5531
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
5428
5532
 
5429
- :param str session_id: 24-char hex id (required)
5533
+ :param str session_id: 24-character hex ID (required)
5430
5534
  :param str file_name: output file name (required)
5431
5535
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
5432
5536
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -5447,7 +5551,7 @@ class Flywheel:
5447
5551
 
5448
5552
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
5449
5553
 
5450
- :param str session_id: 24-char hex id (required)
5554
+ :param str session_id: 24-character hex ID (required)
5451
5555
  :param str file_name: output file name (required)
5452
5556
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
5453
5557
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -5658,7 +5762,7 @@ class Flywheel:
5658
5762
 
5659
5763
 
5660
5764
  def get_session_analyses(self, cid, **kwargs): # noqa: E501
5661
- """Get analyses for session.
5765
+ """Get analyses for a(n) session.
5662
5766
 
5663
5767
  Returns analyses that directly belong to this resource.
5664
5768
 
@@ -5700,7 +5804,7 @@ class Flywheel:
5700
5804
 
5701
5805
  Get info for a particular file.
5702
5806
 
5703
- :param str cid: (required)
5807
+ :param str cid: Container Id (required)
5704
5808
  :param str filename: (required)
5705
5809
  :param bool async_: Perform the request asynchronously
5706
5810
  :return: FileOutput
@@ -5730,9 +5834,9 @@ class Flywheel:
5730
5834
 
5731
5835
 
5732
5836
  def get_session_note(self, cid, note_id, **kwargs): # noqa: E501
5733
- """Get a note on session.
5837
+ """Get a note of a(n) session.
5734
5838
 
5735
- Get a note on session
5839
+ Get a note of a(n) session
5736
5840
 
5737
5841
  :param str cid: (required)
5738
5842
  :param str note_id: (required)
@@ -5825,9 +5929,9 @@ class Flywheel:
5825
5929
 
5826
5930
 
5827
5931
  def modify_session_info(self, cid, body, **kwargs): # noqa: E501
5828
- """Update or replace info for a session.
5932
+ """Update or replace info for a(n) session.
5829
5933
 
5830
- Update or replace info for a session.
5934
+ Update or replace info for a(n) session.
5831
5935
 
5832
5936
  :param str cid: (required)
5833
5937
  :param Info body: (required)
@@ -5838,9 +5942,9 @@ class Flywheel:
5838
5942
 
5839
5943
 
5840
5944
  def modify_session_note(self, cid, note_id, body, **kwargs): # noqa: E501
5841
- """Update a note on session.
5945
+ """Update a note of a(n) session.
5842
5946
 
5843
- Update a note on session
5947
+ Update a note of a(n) session
5844
5948
 
5845
5949
  :param str cid: (required)
5846
5950
  :param str note_id: (required)
@@ -5866,8 +5970,9 @@ class Flywheel:
5866
5970
 
5867
5971
 
5868
5972
  def upload_file_to_session(self, container_id, file, signed=True, **kwargs): # noqa: E501
5869
- """Upload a file to session.
5973
+ """Upload a file to a(n) session.
5870
5974
 
5975
+ Upload a file to a(n) session.
5871
5976
 
5872
5977
  :param str container_id: (required)
5873
5978
  :param str file: The file to upload (required)
@@ -5891,9 +5996,9 @@ class Flywheel:
5891
5996
 
5892
5997
 
5893
5998
  def upload_output_to_session_analysis(self, cid, analysis_id, file, signed=True, **kwargs): # noqa: E501
5894
- """Upload an output file to analysis.
5999
+ """Upload an output file to an analysis.
5895
6000
 
5896
- Upload an output file to analysis
6001
+ Upload an output file to an analysis
5897
6002
 
5898
6003
  :param str cid: (required)
5899
6004
  :param str analysis_id: (required)
@@ -6121,8 +6226,9 @@ class Flywheel:
6121
6226
 
6122
6227
 
6123
6228
  def add_subject_analysis_note(self, container_id, analysis_id, body, **kwargs): # noqa: E501
6124
- """Add a note to subject analysis.
6229
+ """Add a note to a(n) subject analysis.
6125
6230
 
6231
+ Add a note to a(n) subject analysis.
6126
6232
 
6127
6233
  :param str container_id: 24-char hex id (required)
6128
6234
  :param str analysis_id: 24-char hex analysis id (required)
@@ -6134,8 +6240,9 @@ class Flywheel:
6134
6240
 
6135
6241
 
6136
6242
  def add_subject_note(self, container_id, body, **kwargs): # noqa: E501
6137
- """Add a note to subject.
6243
+ """Add a note to a(n) subject.
6138
6244
 
6245
+ Add a note to a(n) subject.
6139
6246
 
6140
6247
  :param str container_id: (required)
6141
6248
  :param NoteInput body: (required)
@@ -6146,7 +6253,7 @@ class Flywheel:
6146
6253
 
6147
6254
 
6148
6255
  def add_subject_tag(self, cid, body, **kwargs): # noqa: E501
6149
- """Add a tag to subject.
6256
+ """Add a tag to a(n) subject.
6150
6257
 
6151
6258
  Propagates changes to projects, sessions and acquisitions
6152
6259
 
@@ -6159,9 +6266,9 @@ class Flywheel:
6159
6266
 
6160
6267
 
6161
6268
  def add_subject_tags(self, cid, body, **kwargs): # noqa: E501
6162
- """Add multiple tags to subject
6269
+ """Add multiple tags to a(n) subject
6163
6270
 
6164
- Add multiple tags to subject
6271
+ Add multiple tags to a(n) subject
6165
6272
 
6166
6273
  :param str cid: (required)
6167
6274
  :param list[str] body: (required)
@@ -6197,7 +6304,7 @@ class Flywheel:
6197
6304
 
6198
6305
 
6199
6306
  def delete_subject_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
6200
- """Delete an anaylsis
6307
+ """Delete an analysis
6201
6308
 
6202
6309
  Delete an analysis for a container.
6203
6310
 
@@ -6211,9 +6318,9 @@ class Flywheel:
6211
6318
 
6212
6319
 
6213
6320
  def delete_subject_analysis_note(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
6214
- """Remove a note from subject analysis.
6321
+ """Remove a note from a(n) subject analysis.
6215
6322
 
6216
- Remove a note from subject analysis.
6323
+ Remove a note from a(n) subject analysis.
6217
6324
 
6218
6325
  :param str cid: 24-char hex id (required)
6219
6326
  :param str analysis_id: 24-char hex analysis id (required)
@@ -6240,9 +6347,9 @@ class Flywheel:
6240
6347
 
6241
6348
 
6242
6349
  def delete_subject_note(self, cid, note_id, **kwargs): # noqa: E501
6243
- """Remove a note from subject
6350
+ """Remove a note from a(n) subject
6244
6351
 
6245
- Remove a note from subject
6352
+ Remove a note from a(n) subject
6246
6353
 
6247
6354
  :param str cid: (required)
6248
6355
  :param str note_id: (required)
@@ -6266,9 +6373,9 @@ class Flywheel:
6266
6373
 
6267
6374
 
6268
6375
  def delete_subject_tags(self, cid, body, **kwargs): # noqa: E501
6269
- """Delete multiple tags from subject
6376
+ """Delete multiple tags from a(n) subject
6270
6377
 
6271
- Delete multiple tags from subject
6378
+ Delete multiple tags from a(n) subject
6272
6379
 
6273
6380
  :param str cid: (required)
6274
6381
  :param list[str] body: (required)
@@ -6278,12 +6385,25 @@ class Flywheel:
6278
6385
  return self.subjects_api.delete_subject_tags(cid, body, **kwargs)
6279
6386
 
6280
6387
 
6388
+ def delete_subjects_by_ids(self, body, **kwargs): # noqa: E501
6389
+ """Delete multiple subjects by ID list
6390
+
6391
+ Delete multiple subjects by ID list
6392
+
6393
+ :param list[str] body: List of IDs to delete (required)
6394
+ :param ContainerDeleteReason delete_reason:
6395
+ :param bool async_: Perform the request asynchronously
6396
+ :return: DeletedResult
6397
+ """
6398
+ return self.subjects_api.delete_subjects_by_ids(body, **kwargs)
6399
+
6400
+
6281
6401
  def download_file_from_subject(self, subject_id, file_name, dest_file, **kwargs): # noqa: E501
6282
6402
  """Download a file.
6283
6403
 
6284
6404
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
6285
6405
 
6286
- :param str subject_id: 24-char hex id (required)
6406
+ :param str subject_id: 24-character hex ID (required)
6287
6407
  :param str file_name: output file name (required)
6288
6408
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
6289
6409
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -6304,7 +6424,7 @@ class Flywheel:
6304
6424
 
6305
6425
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
6306
6426
 
6307
- :param str subject_id: 24-char hex id (required)
6427
+ :param str subject_id: 24-character hex ID (required)
6308
6428
  :param str file_name: output file name (required)
6309
6429
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
6310
6430
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -6325,7 +6445,7 @@ class Flywheel:
6325
6445
 
6326
6446
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
6327
6447
 
6328
- :param str subject_id: 24-char hex id (required)
6448
+ :param str subject_id: 24-character hex ID (required)
6329
6449
  :param str file_name: output file name (required)
6330
6450
  :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
6331
6451
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -6513,7 +6633,7 @@ class Flywheel:
6513
6633
 
6514
6634
 
6515
6635
  def get_subject_analyses(self, cid, **kwargs): # noqa: E501
6516
- """Get analyses for subject.
6636
+ """Get analyses for a(n) subject.
6517
6637
 
6518
6638
  Returns analyses that directly belong to this resource.
6519
6639
 
@@ -6555,7 +6675,7 @@ class Flywheel:
6555
6675
 
6556
6676
  Get info for a particular file.
6557
6677
 
6558
- :param str cid: (required)
6678
+ :param str cid: Container Id (required)
6559
6679
  :param str filename: (required)
6560
6680
  :param bool async_: Perform the request asynchronously
6561
6681
  :return: FileOutput
@@ -6564,9 +6684,9 @@ class Flywheel:
6564
6684
 
6565
6685
 
6566
6686
  def get_subject_note(self, cid, note_id, **kwargs): # noqa: E501
6567
- """Get a note on subject.
6687
+ """Get a note of a(n) subject.
6568
6688
 
6569
- Get a note on subject
6689
+ Get a note of a(n) subject
6570
6690
 
6571
6691
  :param str cid: (required)
6572
6692
  :param str note_id: (required)
@@ -6679,9 +6799,9 @@ class Flywheel:
6679
6799
 
6680
6800
 
6681
6801
  def modify_subject_info(self, cid, body, **kwargs): # noqa: E501
6682
- """Update or replace info for a subject.
6802
+ """Update or replace info for a(n) subject.
6683
6803
 
6684
- Update or replace info for a subject.
6804
+ Update or replace info for a(n) subject.
6685
6805
 
6686
6806
  :param str cid: (required)
6687
6807
  :param Info body: (required)
@@ -6692,9 +6812,9 @@ class Flywheel:
6692
6812
 
6693
6813
 
6694
6814
  def modify_subject_note(self, cid, note_id, body, **kwargs): # noqa: E501
6695
- """Update a note on subject.
6815
+ """Update a note of a(n) subject.
6696
6816
 
6697
- Update a note on subject
6817
+ Update a note of a(n) subject
6698
6818
 
6699
6819
  :param str cid: (required)
6700
6820
  :param str note_id: (required)
@@ -6720,8 +6840,9 @@ class Flywheel:
6720
6840
 
6721
6841
 
6722
6842
  def upload_file_to_subject(self, container_id, file, signed=True, **kwargs): # noqa: E501
6723
- """Upload a file to subject.
6843
+ """Upload a file to a(n) subject.
6724
6844
 
6845
+ Upload a file to a(n) subject.
6725
6846
 
6726
6847
  :param str container_id: (required)
6727
6848
  :param str file: The file to upload (required)
@@ -6745,9 +6866,9 @@ class Flywheel:
6745
6866
 
6746
6867
 
6747
6868
  def upload_output_to_subject_analysis(self, cid, analysis_id, file, signed=True, **kwargs): # noqa: E501
6748
- """Upload an output file to analysis.
6869
+ """Upload an output file to an analysis.
6749
6870
 
6750
- Upload an output file to analysis
6871
+ Upload an output file to an analysis
6751
6872
 
6752
6873
  :param str cid: (required)
6753
6874
  :param str analysis_id: (required)
@@ -7570,7 +7691,7 @@ class Flywheel:
7570
7691
 
7571
7692
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
7572
7693
 
7573
- :param str acquisition_id: 24-char hex id (required)
7694
+ :param str acquisition_id: 24-character hex ID (required)
7574
7695
  :param str file_name: output file name (required)
7575
7696
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
7576
7697
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -7754,7 +7875,7 @@ class Flywheel:
7754
7875
 
7755
7876
  Get Output File
7756
7877
 
7757
- :param str analysis_id: 24-character hex ID (required)
7878
+ :param str analysis_id: Container ID (required)
7758
7879
  :param str filename: output file name (required)
7759
7880
  :param bool info: get file info only
7760
7881
  :param str member: get zipfile member
@@ -7805,7 +7926,7 @@ class Flywheel:
7805
7926
 
7806
7927
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
7807
7928
 
7808
- :param str collection_id: 24-char hex id (required)
7929
+ :param str collection_id: 24-character hex ID (required)
7809
7930
  :param str file_name: output file name (required)
7810
7931
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
7811
7932
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -7924,7 +8045,7 @@ class Flywheel:
7924
8045
 
7925
8046
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
7926
8047
 
7927
- :param str container_id: 24-char hex id (required)
8048
+ :param str container_id: 24-character hex ID (required)
7928
8049
  :param str file_name: output file name (required)
7929
8050
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
7930
8051
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -8103,7 +8224,7 @@ class Flywheel:
8103
8224
 
8104
8225
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
8105
8226
 
8106
- :param str project_id: 24-char hex id (required)
8227
+ :param str project_id: 24-character hex ID (required)
8107
8228
  :param str file_name: output file name (required)
8108
8229
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
8109
8230
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -8266,7 +8387,7 @@ class Flywheel:
8266
8387
 
8267
8388
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
8268
8389
 
8269
- :param str session_id: 24-char hex id (required)
8390
+ :param str session_id: 24-character hex ID (required)
8270
8391
  :param str file_name: output file name (required)
8271
8392
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
8272
8393
  :param str member: The filename of a zipfile member to download rather than the entire file
@@ -8429,7 +8550,7 @@ class Flywheel:
8429
8550
 
8430
8551
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
8431
8552
 
8432
- :param str subject_id: 24-char hex id (required)
8553
+ :param str subject_id: 24-character hex ID (required)
8433
8554
  :param str file_name: output file name (required)
8434
8555
  :param bool info: If the file is a zipfile, return a json response of zipfile member information
8435
8556
  :param str member: The filename of a zipfile member to download rather than the entire file