flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl

flywheel/gear_context.py

@@ -165,7 +165,7 @@ class GearContext(object):
 
         :param str name: The name of the input
         :param str mode: The open mode (default is 'r')
-        :param ``**kwargs``: Additional args to pass to ``open``
+        :param kwargs: Additional args to pass to ``open``
         :return: The file object
         :rtype: file
         """
@@ -180,7 +180,7 @@ class GearContext(object):
 
         :param str name: The name of the output
         :param str mode: The open mode (default is 'w')
-        :param ``**kwargs``: Additional args to pass to ``open``
+        :param kwargs: Additional args to pass to ``open``
         :return: The file object
         :rtype: file
         """
@@ -210,8 +210,8 @@ class GearContext(object):
         if using this as a context manager, when the context is exited.
 
         :param str container_type: The container type (e.g. session or acquisition)
-        :param ``*args``: The optional update dictionary
-        :param ``**kwargs``: The optional update key-value pairs
+        :param args: The optional update dictionary
+        :param kwargs: The optional update key-value pairs
         """
         update = self._create_update_dict(args, kwargs)
         self._update_metadata(container_type, update)
@@ -225,8 +225,8 @@ class GearContext(object):
         if using this as a context manager, when the context is exited.
 
         :param str file_name: The name of the file
-        :param ``*args``: The optional update dictionary
-        :param ``**kwargs``: The optional update key-value pairs
+        :param args: The optional update dictionary
+        :param kwargs: The optional update key-value pairs
         """
         container_type = self.destination["type"]
         update = self._create_update_dict(args, kwargs)
@@ -240,8 +240,8 @@ class GearContext(object):
         The metadata will be written when write_metadata() is called, or
         if using this as a context manager, when the context is exited.
 
-        :param ``*args``: The optional update dictionary
-        :param ``**kwargs``: The optional update key-value pairs
+        :param args: The optional update dictionary
+        :param kwargs: The optional update key-value pairs
         """
         container_type = self.destination["type"]
         update = self._create_update_dict(args, kwargs)
@@ -261,7 +261,7 @@ class GearContext(object):
         :param str target_dir: The destination directory (otherwise work/bids will be used)
         :param bool src_data: Whether or not to include src data (e.g. dicoms)
         :param list folders: The list of folders to include (otherwise all folders) e.g. ['anat', 'func']
-        :param ``**kwargs``: Additional arguments to pass to ``download_bids_dir``
+        :param kwargs: Additional arguments to pass to ``download_bids_dir``
         :return: The absolute path to the downloaded bids directory
         :rtype: str
         """
@@ -279,7 +279,7 @@ class GearContext(object):
         :param list subjects: The list of subjects to include (via subject code) otherwise all subjects
         :param list sessions: The list of sessions to include (via session label) otherwise all sessions
         :param list folders: The list of folders to include (otherwise all folders) e.g. ['anat', 'func']
-        :param ``**kwargs``: Additional arguments to pass to ``download_bids_dir``
+        :param kwargs: Additional arguments to pass to ``download_bids_dir``
         :return: The absolute path to the downloaded bids directory
         :rtype: str
         """

flywheel/models/__init__.py

@@ -2,13 +2,6 @@
 
 # flake8: noqa
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -185,6 +178,7 @@ from flywheel.models.data_view_zip_filter_spec import DataViewZipFilterSpec
 from flywheel.models.default_flywheel_role import DefaultFlywheelRole
 from flywheel.models.deid_log_skip_reason import DeidLogSkipReason
 from flywheel.models.delete_by_search_query import DeleteBySearchQuery
+from flywheel.models.delete_status import DeleteStatus
 from flywheel.models.deleted_file import DeletedFile
 from flywheel.models.deleted_result import DeletedResult
 from flywheel.models.deprecated_action import DeprecatedAction
@@ -305,7 +299,6 @@ from flywheel.models.gear_series_update import GearSeriesUpdate
 from flywheel.models.gear_suggestion_output import GearSuggestionOutput
 from flywheel.models.gear_ticket import GearTicket
 from flywheel.models.gear_ticket_output import GearTicketOutput
-from flywheel.models.google_auth_out import GoogleAuthOut
 from flywheel.models.graph_filter import GraphFilter
 from flywheel.models.group import Group
 from flywheel.models.group_by import GroupBy
@@ -418,6 +411,7 @@ from flywheel.models.legacy_api_key_output import LegacyApiKeyOutput
 from flywheel.models.legacy_input import LegacyInput
 from flywheel.models.legacy_usage_report import LegacyUsageReport
 from flywheel.models.legacys_usage_project_entry import LegacysUsageProjectEntry
+from flywheel.models.libs_viewer_config_models_viewer_config import LibsViewerConfigModelsViewerConfig
 from flywheel.models.libs_workflows_models_parent_type import LibsWorkflowsModelsParentType
 from flywheel.models.libs_workflows_models_task_status import LibsWorkflowsModelsTaskStatus
 from flywheel.models.local_storage import LocalStorage
@@ -431,6 +425,8 @@ from flywheel.models.master_subject_code_dob_input import MasterSubjectCodeDobIn
 from flywheel.models.master_subject_code_input import MasterSubjectCodeInput
 from flywheel.models.master_subject_code_output import MasterSubjectCodeOutput
 from flywheel.models.matched_acquisition_output import MatchedAcquisitionOutput
+from flywheel.models.measurement_config import MeasurementConfig
+from flywheel.models.measurement_item_config import MeasurementItemConfig
 from flywheel.models.modality import Modality
 from flywheel.models.modality_input import ModalityInput
 from flywheel.models.modality_modify import ModalityModify
@@ -474,6 +470,7 @@ from flywheel.models.project_container_output import ProjectContainerOutput
 from flywheel.models.project_copy_input import ProjectCopyInput
 from flywheel.models.project_copy_output import ProjectCopyOutput
 from flywheel.models.project_counters import ProjectCounters
+from flywheel.models.project_delete_status_output import ProjectDeleteStatusOutput
 from flywheel.models.project_group_info import ProjectGroupInfo
 from flywheel.models.project_hierarchy_input import ProjectHierarchyInput
 from flywheel.models.project_hierarchy_output import ProjectHierarchyOutput
@@ -682,6 +679,7 @@ from flywheel.models.task_parent_ref_input import TaskParentRefInput
 from flywheel.models.task_priority import TaskPriority
 from flywheel.models.task_submission import TaskSubmission
 from flywheel.models.therapeutic_area import TherapeuticArea
+from flywheel.models.toolbar_config import ToolbarConfig
 from flywheel.models.transitions import Transitions
 from flywheel.models.tree_container_request_spec import TreeContainerRequestSpec
 from flywheel.models.tree_graph import TreeGraph

flywheel/models/access_level.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/access_permission.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -40,7 +33,13 @@ class AccessPermission(object):
     }
 
     def __init__(self, id=None, access=None):  # noqa: E501
-        """AccessPermission - a model defined in Swagger"""
+        """AccessPermission - a model defined in Swagger
+
+        :param id:, defaults to None
+        :type id: str, optional
+        :param access:, defaults to None
+        :type access: AccessLevel, optional
+        """
         super(AccessPermission, self).__init__()
 
         self._id = None
@@ -56,7 +55,7 @@ class AccessPermission(object):
         """Gets the id of this AccessPermission.
 
 
-        :return: The id of this AccessPermission.
+        :return: The id of this AccessPermission
         :rtype: str
         """
         return self._id
@@ -66,8 +65,8 @@ class AccessPermission(object):
         """Sets the id of this AccessPermission.
 
 
-        :param id: The id of this AccessPermission.  # noqa: E501
-        :type: str
+        :param id: The id of this AccessPermission
+        :type id: str
         """
 
         self._id = id
@@ -77,7 +76,7 @@ class AccessPermission(object):
         """Gets the access of this AccessPermission.
 
 
-        :return: The access of this AccessPermission.
+        :return: The access of this AccessPermission
         :rtype: AccessLevel
         """
         return self._access
@@ -87,8 +86,8 @@ class AccessPermission(object):
         """Sets the access of this AccessPermission.
 
 
-        :param access: The access of this AccessPermission.  # noqa: E501
-        :type: AccessLevel
+        :param access: The access of this AccessPermission
+        :type access: AccessLevel
         """
 
         self._access = access

flywheel/models/access_permission_output.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -40,7 +33,13 @@ class AccessPermissionOutput(object):
     }
 
     def __init__(self, id=None, access=None):  # noqa: E501
-        """AccessPermissionOutput - a model defined in Swagger"""
+        """AccessPermissionOutput - a model defined in Swagger
+
+        :param id:, defaults to None
+        :type id: str, optional
+        :param access:, defaults to None
+        :type access: AccessLevel, optional
+        """
         super(AccessPermissionOutput, self).__init__()
 
         self._id = None
@@ -56,7 +55,7 @@ class AccessPermissionOutput(object):
         """Gets the id of this AccessPermissionOutput.
 
 
-        :return: The id of this AccessPermissionOutput.
+        :return: The id of this AccessPermissionOutput
         :rtype: str
         """
         return self._id
@@ -66,8 +65,8 @@ class AccessPermissionOutput(object):
         """Sets the id of this AccessPermissionOutput.
 
 
-        :param id: The id of this AccessPermissionOutput.  # noqa: E501
-        :type: str
+        :param id: The id of this AccessPermissionOutput
+        :type id: str
         """
 
         self._id = id
@@ -77,7 +76,7 @@ class AccessPermissionOutput(object):
         """Gets the access of this AccessPermissionOutput.
 
 
-        :return: The access of this AccessPermissionOutput.
+        :return: The access of this AccessPermissionOutput
         :rtype: AccessLevel
         """
         return self._access
@@ -87,8 +86,8 @@ class AccessPermissionOutput(object):
         """Sets the access of this AccessPermissionOutput.
 
 
-        :param access: The access of this AccessPermissionOutput.  # noqa: E501
-        :type: AccessLevel
+        :param access: The access of this AccessPermissionOutput
+        :type access: AccessLevel
         """
 
         self._access = access

flywheel/models/access_permission_update.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -37,7 +30,11 @@ class AccessPermissionUpdate(object):
     }
 
     def __init__(self, access=None):  # noqa: E501
-        """AccessPermissionUpdate - a model defined in Swagger"""
+        """AccessPermissionUpdate - a model defined in Swagger
+
+        :param access:, defaults to None
+        :type access: AccessLevel, optional
+        """
         super(AccessPermissionUpdate, self).__init__()
 
         self._access = None
@@ -51,7 +48,7 @@ class AccessPermissionUpdate(object):
         """Gets the access of this AccessPermissionUpdate.
 
 
-        :return: The access of this AccessPermissionUpdate.
+        :return: The access of this AccessPermissionUpdate
         :rtype: AccessLevel
         """
         return self._access
@@ -61,8 +58,8 @@ class AccessPermissionUpdate(object):
         """Sets the access of this AccessPermissionUpdate.
 
 
-        :param access: The access of this AccessPermissionUpdate.  # noqa: E501
-        :type: AccessLevel
+        :param access: The access of this AccessPermissionUpdate
+        :type access: AccessLevel
         """
 
         self._access = access

flywheel/models/access_type.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/accumulator.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/acquisition.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/acquisition_container_output.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/acquisition_copy_input.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -43,7 +36,15 @@ class AcquisitionCopyInput(object):
     }
 
     def __init__(self, label=None, dst_session_id=None, filter=None):  # noqa: E501
-        """AcquisitionCopyInput - a model defined in Swagger"""
+        """AcquisitionCopyInput - a model defined in Swagger
+
+        :param label: Label to apply to the copied acquisition, defaults to None
+        :type label: str, optional
+        :param dst_session_id: Session to copy to, defaults to None
+        :type dst_session_id: str, optional
+        :param filter:, defaults to None
+        :type filter: CopyFilter, optional
+        """
         super(AcquisitionCopyInput, self).__init__()
 
         self._label = None
@@ -63,7 +64,7 @@ class AcquisitionCopyInput(object):
 
         Label to apply to the copied acquisition
 
-        :return: The label of this AcquisitionCopyInput.
+        :return: The label of this AcquisitionCopyInput
         :rtype: str
         """
         return self._label
@@ -74,8 +75,8 @@ class AcquisitionCopyInput(object):
 
         Label to apply to the copied acquisition
 
-        :param label: The label of this AcquisitionCopyInput.  # noqa: E501
-        :type: str
+        :param label: The label of this AcquisitionCopyInput
+        :type label: str
         """
 
         self._label = label
@@ -86,7 +87,7 @@ class AcquisitionCopyInput(object):
 
         Session to copy to
 
-        :return: The dst_session_id of this AcquisitionCopyInput.
+        :return: The dst_session_id of this AcquisitionCopyInput
         :rtype: str
         """
         return self._dst_session_id
@@ -97,8 +98,8 @@ class AcquisitionCopyInput(object):
 
         Session to copy to
 
-        :param dst_session_id: The dst_session_id of this AcquisitionCopyInput.  # noqa: E501
-        :type: str
+        :param dst_session_id: The dst_session_id of this AcquisitionCopyInput
+        :type dst_session_id: str
         """
 
         self._dst_session_id = dst_session_id
@@ -108,7 +109,7 @@ class AcquisitionCopyInput(object):
         """Gets the filter of this AcquisitionCopyInput.
 
 
-        :return: The filter of this AcquisitionCopyInput.
+        :return: The filter of this AcquisitionCopyInput
         :rtype: CopyFilter
         """
         return self._filter
@@ -118,8 +119,8 @@ class AcquisitionCopyInput(object):
         """Sets the filter of this AcquisitionCopyInput.
 
 
-        :param filter: The filter of this AcquisitionCopyInput.  # noqa: E501
-        :type: CopyFilter
+        :param filter: The filter of this AcquisitionCopyInput
+        :type filter: CopyFilter
         """
 
         self._filter = filter

flywheel/models/acquisition_input.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -49,7 +42,21 @@ class AcquisitionInput(object):
     }
 
     def __init__(self, label=None, session=None, uid=None, timestamp=None, timezone=None, info=None):  # noqa: E501
-        """AcquisitionInput - a model defined in Swagger"""
+        """AcquisitionInput - a model defined in Swagger
+
+        :param label:, defaults to None
+        :type label: str, optional
+        :param session:, defaults to None
+        :type session: str, optional
+        :param uid:, defaults to None
+        :type uid: str, optional
+        :param timestamp:, defaults to None
+        :type timestamp: datetime, optional
+        :param timezone:, defaults to None
+        :type timezone: str, optional
+        :param info:, defaults to None
+        :type info: object, optional
+        """
         super(AcquisitionInput, self).__init__()
 
         self._label = None
@@ -77,7 +84,7 @@ class AcquisitionInput(object):
         """Gets the label of this AcquisitionInput.
 
 
-        :return: The label of this AcquisitionInput.
+        :return: The label of this AcquisitionInput
         :rtype: str
         """
         return self._label
@@ -87,8 +94,8 @@ class AcquisitionInput(object):
         """Sets the label of this AcquisitionInput.
 
 
-        :param label: The label of this AcquisitionInput.  # noqa: E501
-        :type: str
+        :param label: The label of this AcquisitionInput
+        :type label: str
         """
 
         self._label = label
@@ -98,7 +105,7 @@ class AcquisitionInput(object):
         """Gets the session of this AcquisitionInput.
 
 
-        :return: The session of this AcquisitionInput.
+        :return: The session of this AcquisitionInput
         :rtype: str
         """
         return self._session
@@ -108,8 +115,8 @@ class AcquisitionInput(object):
         """Sets the session of this AcquisitionInput.
 
 
-        :param session: The session of this AcquisitionInput.  # noqa: E501
-        :type: str
+        :param session: The session of this AcquisitionInput
+        :type session: str
         """
 
         self._session = session
@@ -119,7 +126,7 @@ class AcquisitionInput(object):
         """Gets the uid of this AcquisitionInput.
 
 
-        :return: The uid of this AcquisitionInput.
+        :return: The uid of this AcquisitionInput
         :rtype: str
         """
         return self._uid
@@ -129,8 +136,8 @@ class AcquisitionInput(object):
         """Sets the uid of this AcquisitionInput.
 
 
-        :param uid: The uid of this AcquisitionInput.  # noqa: E501
-        :type: str
+        :param uid: The uid of this AcquisitionInput
+        :type uid: str
         """
 
         self._uid = uid
@@ -140,7 +147,7 @@ class AcquisitionInput(object):
         """Gets the timestamp of this AcquisitionInput.
 
 
-        :return: The timestamp of this AcquisitionInput.
+        :return: The timestamp of this AcquisitionInput
         :rtype: datetime
         """
         return self._timestamp
@@ -150,8 +157,8 @@ class AcquisitionInput(object):
         """Sets the timestamp of this AcquisitionInput.
 
 
-        :param timestamp: The timestamp of this AcquisitionInput.  # noqa: E501
-        :type: datetime
+        :param timestamp: The timestamp of this AcquisitionInput
+        :type timestamp: datetime
         """
 
         self._timestamp = timestamp
@@ -161,7 +168,7 @@ class AcquisitionInput(object):
         """Gets the timezone of this AcquisitionInput.
 
 
-        :return: The timezone of this AcquisitionInput.
+        :return: The timezone of this AcquisitionInput
         :rtype: str
         """
         return self._timezone
@@ -171,8 +178,8 @@ class AcquisitionInput(object):
         """Sets the timezone of this AcquisitionInput.
 
 
-        :param timezone: The timezone of this AcquisitionInput.  # noqa: E501
-        :type: str
+        :param timezone: The timezone of this AcquisitionInput
+        :type timezone: str
         """
 
         self._timezone = timezone
@@ -182,7 +189,7 @@ class AcquisitionInput(object):
         """Gets the info of this AcquisitionInput.
 
 
-        :return: The info of this AcquisitionInput.
+        :return: The info of this AcquisitionInput
         :rtype: object
         """
         return self._info
@@ -192,8 +199,8 @@ class AcquisitionInput(object):
         """Sets the info of this AcquisitionInput.
 
 
-        :param info: The info of this AcquisitionInput.  # noqa: E501
-        :type: object
+        :param info: The info of this AcquisitionInput
+        :type info: object
         """
 
         self._info = info