flywheel-sdk 17.5.1rc1__py2.py3-none-any.whl → 17.6.0__py2.py3-none-any.whl

flywheel/__init__.py

@@ -25,12 +25,12 @@ from flywheel.api.audit_trail_api import AuditTrailApi
 from flywheel.api.auth_api import AuthApi
 from flywheel.api.batch_api import BatchApi
 from flywheel.api.bulk_api import BulkApi
+from flywheel.api.change_log_api import ChangeLogApi
 from flywheel.api.collections_api import CollectionsApi
 from flywheel.api.config_api import ConfigApi
 from flywheel.api.containers_api import ContainersApi
 from flywheel.api.data_view_executions_api import DataViewExecutionsApi
 from flywheel.api.dataexplorer_api import DataexplorerApi
-from flywheel.api.default_api import DefaultApi
 from flywheel.api.devices_api import DevicesApi
 from flywheel.api.dimse_api import DimseApi
 from flywheel.api.download_api import DownloadApi
@@ -125,6 +125,10 @@ from flywheel.models.bulk_move_input import BulkMoveInput
 from flywheel.models.bulk_move_sessions import BulkMoveSessions
 from flywheel.models.cancelled_batch_output import CancelledBatchOutput
 from flywheel.models.catalog_list_output import CatalogListOutput
+from flywheel.models.change import Change
+from flywheel.models.change_log_container_type import ChangeLogContainerType
+from flywheel.models.change_log_document import ChangeLogDocument
+from flywheel.models.change_method import ChangeMethod
 from flywheel.models.channel import Channel
 from flywheel.models.classic_batch_job_output import ClassicBatchJobOutput
 from flywheel.models.classic_batch_job_output_inflated_jobs import ClassicBatchJobOutputInflatedJobs
@@ -182,6 +186,7 @@ from flywheel.models.create_report_input import CreateReportInput
 from flywheel.models.creds import Creds
 from flywheel.models.curator import Curator
 from flywheel.models.current_user_output import CurrentUserOutput
+from flywheel.models.daily_report_usage import DailyReportUsage
 from flywheel.models.data_strategy import DataStrategy
 from flywheel.models.data_view import DataView
 from flywheel.models.data_view_analysis_file_spec import DataViewAnalysisFileSpec
@@ -251,7 +256,6 @@ from flywheel.models.file_reference import FileReference
 from flywheel.models.file_suggestion import FileSuggestion
 from flywheel.models.file_template_options import FileTemplateOptions
 from flywheel.models.file_upsert_input import FileUpsertInput
-from flywheel.models.file_upsert_origin import FileUpsertOrigin
 from flywheel.models.file_upsert_output import FileUpsertOutput
 from flywheel.models.file_version import FileVersion
 from flywheel.models.file_version_copy_of import FileVersionCopyOf
@@ -401,6 +405,8 @@ from flywheel.models.ldap_sync_input import LdapSyncInput
 from flywheel.models.ldap_sync_status import LdapSyncStatus
 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.local_storage import LocalStorage
 from flywheel.models.location import Location
 from flywheel.models.locked import Locked
@@ -433,6 +439,7 @@ from flywheel.models.packfile_removed_output import PackfileRemovedOutput
 from flywheel.models.packfile_start import PackfileStart
 from flywheel.models.page import Page
 from flywheel.models.page_file_output_ import PageFileOutput_
+from flywheel.models.parent_type import ParentType
 from flywheel.models.parsed_query_response import ParsedQueryResponse
 from flywheel.models.permission_access_permission import PermissionAccessPermission
 from flywheel.models.premade_jobs_batch_job_output import PremadeJobsBatchJobOutput
@@ -499,14 +506,14 @@ from flywheel.models.report_access_log_context_entry import ReportAccessLogConte
 from flywheel.models.report_access_log_context_file_entry import ReportAccessLogContextFileEntry
 from flywheel.models.report_access_log_entry import ReportAccessLogEntry
 from flywheel.models.report_access_log_origin import ReportAccessLogOrigin
+from flywheel.models.report_availability_list import ReportAvailabilityList
 from flywheel.models.report_daily_usage_entry import ReportDailyUsageEntry
 from flywheel.models.report_demographics_grid import ReportDemographicsGrid
 from flywheel.models.report_group_report import ReportGroupReport
-from flywheel.models.report_legacy_usage_entry import ReportLegacyUsageEntry
-from flywheel.models.report_legacy_usage_project_entry import ReportLegacyUsageProjectEntry
 from flywheel.models.report_project import ReportProject
 from flywheel.models.report_site import ReportSite
 from flywheel.models.report_time_period import ReportTimePeriod
+from flywheel.models.report_usage import ReportUsage
 from flywheel.models.report_usage_entry import ReportUsageEntry
 from flywheel.models.resolve_input import ResolveInput
 from flywheel.models.resolve_output import ResolveOutput
@@ -527,6 +534,12 @@ from flywheel.models.roles_role_input import RolesRoleInput
 from flywheel.models.rule import Rule
 from flywheel.models.rule_any import RuleAny
 from flywheel.models.s3_compat_storage import S3CompatStorage
+from flywheel.models.save_search import SaveSearch
+from flywheel.models.save_search_input import SaveSearchInput
+from flywheel.models.save_search_output import SaveSearchOutput
+from flywheel.models.save_search_page import SaveSearchPage
+from flywheel.models.save_search_parent import SaveSearchParent
+from flywheel.models.save_search_update import SaveSearchUpdate
 from flywheel.models.search_acquisition_response import SearchAcquisitionResponse
 from flywheel.models.search_analysis_response import SearchAnalysisResponse
 from flywheel.models.search_collection_response import SearchCollectionResponse
@@ -539,14 +552,13 @@ from flywheel.models.search_parent_session import SearchParentSession
 from flywheel.models.search_parse_error import SearchParseError
 from flywheel.models.search_project_response import SearchProjectResponse
 from flywheel.models.search_query import SearchQuery
-from flywheel.models.search_query_suggestions import SearchQuerySuggestions
 from flywheel.models.search_response import SearchResponse
 from flywheel.models.search_return_type import SearchReturnType
 from flywheel.models.search_session_response import SearchSessionResponse
 from flywheel.models.search_status import SearchStatus
 from flywheel.models.search_structured_search_query import SearchStructuredSearchQuery
 from flywheel.models.search_subject_response import SearchSubjectResponse
-from flywheel.models.search_suggestion import SearchSuggestion
+from flywheel.models.server_state import ServerState
 from flywheel.models.service_aet import ServiceAET
 from flywheel.models.service_aet_input import ServiceAETInput
 from flywheel.models.session import Session
@@ -563,6 +575,7 @@ from flywheel.models.session_template_recalc_output import SessionTemplateRecalc
 from flywheel.models.session_upsert_input import SessionUpsertInput
 from flywheel.models.session_upsert_output import SessionUpsertOutput
 from flywheel.models.sharing_filter_options import SharingFilterOptions
+from flywheel.models.signed_fs_upload_output import SignedFSUploadOutput
 from flywheel.models.signed_url_upload_input import SignedUrlUploadInput
 from flywheel.models.signed_url_upload_output import SignedUrlUploadOutput
 from flywheel.models.site import Site
@@ -570,11 +583,15 @@ from flywheel.models.site_report import SiteReport
 from flywheel.models.site_settings import SiteSettings
 from flywheel.models.sort import Sort
 from flywheel.models.stable_api_key_input import StableApiKeyInput
+from flywheel.models.state import State
 from flywheel.models.static_compute import StaticCompute
+from flywheel.models.status_type import StatusType
 from flywheel.models.status_value import StatusValue
 from flywheel.models.storage_strategy import StorageStrategy
 from flywheel.models.storage_strategy_config import StorageStrategyConfig
 from flywheel.models.structured_query import StructuredQuery
+from flywheel.models.structured_query_suggestions import StructuredQuerySuggestions
+from flywheel.models.structured_query_value_suggestion import StructuredQueryValueSuggestion
 from flywheel.models.subject import Subject
 from flywheel.models.subject_container_output import SubjectContainerOutput
 from flywheel.models.subject_input import SubjectInput
@@ -592,23 +609,20 @@ from flywheel.models.tag import Tag
 from flywheel.models.therapeutic_area import TherapeuticArea
 from flywheel.models.transitions import Transitions
 from flywheel.models.tree_container_request_spec import TreeContainerRequestSpec
-from flywheel.models.tree_graph import TreeGraph
 from flywheel.models.tree_graph_connection import TreeGraphConnection
-from flywheel.models.tree_graph_connections import TreeGraphConnections
 from flywheel.models.tree_graph_node import TreeGraphNode
 from flywheel.models.tree_request import TreeRequest
-from flywheel.models.tree_response_item import TreeResponseItem
 from flywheel.models.type_str import TypeStr
 from flywheel.models.uid_check_input_acquisitions import UidCheckInputAcquisitions
 from flywheel.models.uid_check_input_sessions import UidCheckInputSessions
 from flywheel.models.uid_check_output import UidCheckOutput
 from flywheel.models.upload_complete_s3_multipart_input import UploadCompleteS3MultipartInput
 from flywheel.models.upload_complete_s3_multipart_output import UploadCompleteS3MultipartOutput
-from flywheel.models.upload_signed_fs_file_upload_output import UploadSignedFsFileUploadOutput
 from flywheel.models.upload_signed_upload_url_input import UploadSignedUploadUrlInput
 from flywheel.models.upload_signed_upload_url_output import UploadSignedUploadUrlOutput
 from flywheel.models.upload_ticket_output import UploadTicketOutput
 from flywheel.models.upload_token_output import UploadTokenOutput
+from flywheel.models.upsert_result import UpsertResult
 from flywheel.models.user import User
 from flywheel.models.user_api_key import UserApiKey
 from flywheel.models.user_input import UserInput
@@ -628,9 +642,10 @@ from flywheel.models.viewer_app_type import ViewerAppType
 from flywheel.models.virus_scan import VirusScan
 from flywheel.models.virus_scan_state import VirusScanState
 from flywheel.models.work_in_progress_features import WorkInProgressFeatures
-from flywheel.models.workspace import Workspace
+from flywheel.models.workspace_modify import WorkspaceModify
 from flywheel.models.workspace_origin import WorkspaceOrigin
 from flywheel.models.workspace_output import WorkspaceOutput
+from flywheel.models.workspace_response import WorkspaceResponse
 from flywheel.models.workspace_update import WorkspaceUpdate
 from flywheel.models.zipfile_info import ZipfileInfo
 from flywheel.models.zipfile_member_info import ZipfileMemberInfo

flywheel/api/__init__.py

@@ -9,12 +9,12 @@ from flywheel.api.audit_trail_api import AuditTrailApi
 from flywheel.api.auth_api import AuthApi
 from flywheel.api.batch_api import BatchApi
 from flywheel.api.bulk_api import BulkApi
+from flywheel.api.change_log_api import ChangeLogApi
 from flywheel.api.collections_api import CollectionsApi
 from flywheel.api.config_api import ConfigApi
 from flywheel.api.containers_api import ContainersApi
 from flywheel.api.data_view_executions_api import DataViewExecutionsApi
 from flywheel.api.dataexplorer_api import DataexplorerApi
-from flywheel.api.default_api import DefaultApi
 from flywheel.api.devices_api import DevicesApi
 from flywheel.api.dimse_api import DimseApi
 from flywheel.api.download_api import DownloadApi

flywheel/api/acquisitions_api.py

@@ -265,7 +265,7 @@ class AcquisitionsApi(object):
 
         :param str container_id: 24-char hex id (required)
         :param str analysis_id: 24-char hex analysis id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -292,7 +292,7 @@ class AcquisitionsApi(object):
 
         :param str container_id: 24-char hex id (required)
         :param str analysis_id: 24-char hex analysis id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async: Perform the request asynchronously
         :return: Note
         """

flywheel/api/analyses_api.py

@@ -37,7 +37,7 @@ class AnalysesApi(object):
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: Container id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -64,7 +64,7 @@ class AnalysesApi(object):
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: Container id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async: Perform the request asynchronously
         :return: Note
         """
@@ -1922,7 +1922,7 @@ class AnalysesApi(object):
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-char hex analysis id (required)
-        :param AnalysisModifyInput body: (required)
+        :param AnalysisModifyInput body: new analysis fields (required)
         :param bool async_: Perform the request asynchronously
         :return: ModifiedResult
         """
@@ -1949,7 +1949,7 @@ class AnalysesApi(object):
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-char hex analysis id (required)
-        :param AnalysisModifyInput body: (required)
+        :param AnalysisModifyInput body: new analysis fields (required)
         :param bool async: Perform the request asynchronously
         :return: ModifiedResult
         """
@@ -2153,7 +2153,7 @@ class AnalysesApi(object):
 
         :param str container_id: Container id (required)
         :param str note_id: 24-char hex note id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async_: Perform the request asynchronously
         :return: int
         """
@@ -2181,7 +2181,7 @@ class AnalysesApi(object):
 
         :param str container_id: Container id (required)
         :param str note_id: 24-char hex note id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async: Perform the request asynchronously
         :return: int
         """

flywheel/api/batch_api.py

@@ -425,7 +425,7 @@ class BatchApi(object):
         Create a batch job proposal and insert it as 'pending'.
         This method makes a synchronous HTTP request by default.
 
-        :param ClassicBatchProposalInput body: (required)
+        :param ClassicBatchProposalInput body: The batch proposal (required)
         :param bool async_: Perform the request asynchronously
         :return: ClassicBatchProposalOutput
         """
@@ -451,7 +451,7 @@ class BatchApi(object):
         Create a batch job proposal and insert it as 'pending'.
         This method makes a synchronous HTTP request by default.
 
-        :param ClassicBatchProposalInput body: (required)
+        :param ClassicBatchProposalInput body: The batch proposal (required)
         :param bool async: Perform the request asynchronously
         :return: ClassicBatchProposalOutput
         """

flywheel/api/change_log_api.py

@@ -0,0 +1,137 @@
+# 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
+"""
+
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from flywheel.api_client import ApiClient
+import flywheel.models
+
+# NOTE: This file is auto generated by the swagger code generator program.
+# Do not edit the class manually.
+
+class ChangeLogApi(object):
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_change_log(self, container_type, container_id, **kwargs):  # noqa: E501
+        """Get Change Log
+
+        This method makes a synchronous HTTP request by default.
+
+        :param ChangeLogContainerType container_type: (required)
+        :param str container_id: (required)
+        :param int version: Optional version if retrieving logs for file
+        :param bool async_: Perform the request asynchronously
+        :return: ChangeLogDocument
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_change_log_with_http_info(container_type, container_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_change_log_with_http_info(container_type, container_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def get_change_log_with_http_info(self, container_type, container_id, **kwargs):  # noqa: E501
+        """Get Change Log
+
+        This method makes a synchronous HTTP request by default.
+
+        :param ChangeLogContainerType container_type: (required)
+        :param str container_id: (required)
+        :param int version: Optional version if retrieving logs for file
+        :param bool async: Perform the request asynchronously
+        :return: ChangeLogDocument
+        """
+
+        all_params = ['container_type','container_id','version',]  # noqa: E501
+        all_params.append('async_')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_request_out')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_change_log" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'container_type' is set
+        if ('container_type' not in params or
+                params['container_type'] is None):
+            raise ValueError("Missing the required parameter `container_type` when calling `get_change_log`")  # noqa: E501
+        # verify the required parameter 'container_id' is set
+        if ('container_id' not in params or
+                params['container_id'] is None):
+            raise ValueError("Missing the required parameter `container_id` when calling `get_change_log`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'container_type' in params:
+            path_params['container_type'] = params['container_type']  # noqa: E501
+        if 'container_id' in params:
+            path_params['container_id'] = params['container_id']  # noqa: E501
+
+        query_params = []
+        if 'version' in params:
+            query_params.append(('version', params['version']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/changes/{container_type}/{container_id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ChangeLogDocument',  # noqa: E501
+            auth_settings=auth_settings,
+            async_=params.get('async_'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            _request_out=params.get('_request_out'),
+            collection_formats=collection_formats)

flywheel/api/config_api.py

@@ -118,6 +118,94 @@ class ConfigApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def get_config_js(self, **kwargs):  # noqa: E501
+        """Return public Scitran configuration information in javascript format.
+
+        return config as a JavaScript string assignment
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_config_js_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_config_js_with_http_info(**kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def get_config_js_with_http_info(self, **kwargs):  # noqa: E501
+        """Return public Scitran configuration information in javascript format.
+
+        return config as a JavaScript string assignment
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async: Perform the request asynchronously
+        :return: object
+        """
+
+        all_params = []  # noqa: E501
+        all_params.append('async_')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_request_out')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_config_js" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/javascript'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/config.js', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='object',  # noqa: E501
+            auth_settings=auth_settings,
+            async_=params.get('async_'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            _request_out=params.get('_request_out'),
+            collection_formats=collection_formats)
+
     def get_version(self, **kwargs):  # noqa: E501
         """Get server and database schema version info
 

flywheel/api/containers_api.py

@@ -158,7 +158,7 @@ class ContainersApi(object):
 
         :param str container_id: 24-char hex id (required)
         :param str analysis_id: 24-char hex analysis id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -185,7 +185,7 @@ class ContainersApi(object):
 
         :param str container_id: 24-char hex id (required)
         :param str analysis_id: 24-char hex analysis id (required)
-        :param NoteInput body: (required)
+        :param NoteInput body: note content (required)
         :param bool async: Perform the request asynchronously
         :return: Note
         """