flywheel-sdk 20.5.0rc0__py2.py3-none-any.whl → 20.6.0rc2__py2.py3-none-any.whl

flywheel/api/groups_api.py

@@ -1362,7 +1362,7 @@ class GroupsApi(object):
         Delete multiple groups by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -1389,7 +1389,7 @@ class GroupsApi(object):
         Delete multiple groups by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult

flywheel/api/projects_api.py

@@ -2061,7 +2061,7 @@ class ProjectsApi(object):
         Delete multiple projects by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -2088,7 +2088,7 @@ class ProjectsApi(object):
         Delete multiple projects by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult

flywheel/api/sessions_api.py

@@ -1596,7 +1596,7 @@ class SessionsApi(object):
         Delete multiple sessions by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -1623,7 +1623,7 @@ class SessionsApi(object):
         Delete multiple sessions by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult

flywheel/api/subjects_api.py

@@ -1704,7 +1704,7 @@ class SubjectsApi(object):
         Delete multiple subjects by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -1731,7 +1731,7 @@ class SubjectsApi(object):
         Delete multiple subjects by query
         This method makes a synchronous HTTP request by default.
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult

flywheel/api_client.py

@@ -84,7 +84,7 @@ class ApiClient(object):
         self.default_query_params = []
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/20.5.0-rc0/python'
+        self.user_agent = 'Swagger-Codegen/20.6.0-rc2/python'
         self.last_response = None
         self._version_check_fn = None
         self._context = context

flywheel/configuration.py

@@ -253,8 +253,8 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 20.5.0-rc0\n"\
-               "SDK Package Version: 20.5.0-rc0".\
+               "Version of the API: 20.6.0-rc2\n"\
+               "SDK Package Version: 20.6.0-rc2".\
                format(env=sys.platform, pyversion=sys.version)
 
     def enable_message_cutoff(self, message_cutoff):

flywheel/flywheel.py

@@ -40,7 +40,7 @@ from flywheel.view_builder import ViewBuilder
 from flywheel.finder import Finder
 import flywheel.api
 
-SDK_VERSION = "20.5.0-rc0"
+SDK_VERSION = "20.6.0-rc2"
 
 def config_from_api_key(api_key):
     parts = api_key.split(':')
@@ -145,6 +145,7 @@ class Flywheel:
         self.config_api = flywheel.api.ConfigApi(self.api_client)
         self.container_type_api = flywheel.api.ContainerTypeApi(self.api_client)
         self.containers_api = flywheel.api.ContainersApi(self.api_client)
+        self.custom_filters_api = flywheel.api.CustomFiltersApi(self.api_client)
         self.data_view_executions_api = flywheel.api.DataViewExecutionsApi(self.api_client)
         self.dataexplorer_api = flywheel.api.DataexplorerApi(self.api_client)
         self.devices_api = flywheel.api.DevicesApi(self.api_client)
@@ -412,7 +413,7 @@ class Flywheel:
 
         Delete multiple acquisitions by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -932,7 +933,7 @@ class Flywheel:
 
         Delete multiple analyses by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -1763,7 +1764,7 @@ class Flywheel:
 
         Delete multiple collections by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -2634,14 +2635,15 @@ class Flywheel:
         View all containers
 
         :param str container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view. (required)
-        :param str filter:
-        :param str sort:
-        :param int limit:
-        :param int skip:
-        :param int page:
-        :param str after_id:
+        :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param list[union[HeaderFeature,str]] x_accept_feature:
         :param bool async_: Perform the request asynchronously
-        :return: list[ViewOutput]
+        :return: union[Page,list[ViewOutput]]
         """
         return self.containers_api.get_views(container_id, **kwargs)
 
@@ -2806,6 +2808,60 @@ class Flywheel:
         return self.containers_api.upload_output_to_container_analysis(cid, analysis_id, file, **kwargs)
 
 
+    def create_custom_filter(self, body, **kwargs):  # noqa: E501
+        """Create a custom filter for user
+
+        Creates a custom filter for the user  Args:     filter_input: The input model for creating a filter     auth_session: The user auth session for permission Checks  Returns:     Filter: A customer saved filter  Raises:     BusinessLogicError: when auth session does not have user set
+
+        :param FilterInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: CoreModelsCustomFiltersFilter
+        """
+        return self.custom_filters_api.create_custom_filter(body, **kwargs)
+
+
+    def delete_custom_filter(self, custom_filter_id, **kwargs):  # noqa: E501
+        """Delete a custom filter for user
+
+        Deletes a custom filter for the authenticated user  Args:     custom_filter_id: The ID of the filter to delete     auth_session: The user auth session for permission checks  Returns:     DeletedResult: Result indicating the number of deleted filters  Raises:     BusinessLogicError: when auth session does not have user privilege     ResourceNotFound: when the filter doesn't exist     PermissionError: when the filter doesn't belong to the user's origin
+
+        :param str custom_filter_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
+        """
+        return self.custom_filters_api.delete_custom_filter(custom_filter_id, **kwargs)
+
+
+    def get_all_custom_filters(self, **kwargs):  # noqa: E501
+        """Get all custom filters for user
+
+        Retrieves all custom filters for the authenticated user's origin  Args:     pagination: Pagination parameters for the query     auth_session: The user auth session for permission checks  Returns:     Page[Filter]: A paginated list of custom filters matching the user's origin  Raises:     BusinessLogicError: when auth session does not have user privilege
+
+        :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param bool async_: Perform the request asynchronously
+        :return: PageGenericFilter
+        """
+        return self.custom_filters_api.get_all_custom_filters(**kwargs)
+
+
+    def update_custom_filter(self, custom_filter_id, body, **kwargs):  # noqa: E501
+        """Update a custom filter for user
+
+        Updates an existing custom filter  Args:     custom_filter_id: The ID of the filter to update     filter_input: The input model for updating a filter     auth_session: The user auth session for permission checks  Returns:     Filter: The updated custom filter  Raises:     BusinessLogicError: when auth session does not have user privilege or origin mismatch
+
+        :param str custom_filter_id: (required)
+        :param FilterInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: CoreModelsCustomFiltersFilter
+        """
+        return self.custom_filters_api.update_custom_filter(custom_filter_id, body, **kwargs)
+
+
     def delete_view_execution(self, data_view_execution_id, **kwargs):  # noqa: E501
         """Delete a data_view_execution
 
@@ -3312,7 +3368,7 @@ class Flywheel:
 
         Delete multiple files by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -3870,7 +3926,7 @@ class Flywheel:
 
         Delete multiple groups by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -4648,7 +4704,7 @@ class Flywheel:
 
         Delete multiple projects by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -5835,7 +5891,7 @@ class Flywheel:
 
         Delete multiple sessions by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
@@ -6744,7 +6800,7 @@ class Flywheel:
 
         Delete multiple subjects by query
 
-        :param list[Filter] body: Query for containers to delete (required)
+        :param list[CoreModelsPaginationsFilter] body: Query for containers to delete (required)
         :param ContainerDeleteReason delete_reason:
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult

flywheel/models/__init__.py

@@ -6,7 +6,7 @@
 
     Flywheel: API for data import, automated curation, image processing, machine learning workflows, and secure collaboration.  # noqa: E501
 
-    OpenAPI spec version: 20.5.0-rc0
+    OpenAPI spec version: 20.6.0-rc2
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -150,7 +150,9 @@ from flywheel.models.copy_filter import CopyFilter
 from flywheel.models.copy_status import CopyStatus
 from flywheel.models.core_models_api_key_api_key_input import CoreModelsApiKeyApiKeyInput
 from flywheel.models.core_models_common_source import CoreModelsCommonSource
+from flywheel.models.core_models_custom_filters_filter import CoreModelsCustomFiltersFilter
 from flywheel.models.core_models_jobs_api_key_input import CoreModelsJobsApiKeyInput
+from flywheel.models.core_models_paginations_filter import CoreModelsPaginationsFilter
 from flywheel.models.create_report_input import CreateReportInput
 from flywheel.models.creds import Creds
 from flywheel.models.curator import Curator
@@ -240,8 +242,9 @@ from flywheel.models.file_version_output import FileVersionOutput
 from flywheel.models.file_via import FileVia
 from flywheel.models.file_zip_entry import FileZipEntry
 from flywheel.models.file_zip_info import FileZipInfo
-from flywheel.models.filter import Filter
+from flywheel.models.filter_input import FilterInput
 from flywheel.models.filter_values import FilterValues
+from flywheel.models.filter_view import FilterView
 from flywheel.models.fixed_file_version_input import FixedFileVersionInput
 from flywheel.models.fixed_input import FixedInput
 from flywheel.models.form_definition import FormDefinition
@@ -430,6 +433,7 @@ from flywheel.models.packfile_cleanup_output import PackfileCleanupOutput
 from flywheel.models.packfile_removed_output import PackfileRemovedOutput
 from flywheel.models.page import Page
 from flywheel.models.page_generic_file_output import PageGenericFileOutput
+from flywheel.models.page_generic_filter import PageGenericFilter
 from flywheel.models.parent_type import ParentType
 from flywheel.models.parsed_query_response import ParsedQueryResponse
 from flywheel.models.permission_access_permission import PermissionAccessPermission

flywheel/models/core_models_custom_filters_filter.py

@@ -0,0 +1,348 @@
+# 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
+"""
+
+
+## NOTE: This file is auto generated by the swagger code generator program.
+## Do not edit the file manually.
+
+import pprint
+import re  # noqa: F401
+import six
+
+from flywheel.models.filter_view import FilterView  # noqa: F401,E501
+from flywheel.models.origin import Origin  # noqa: F401,E501
+
+class CoreModelsCustomFiltersFilter(object):
+
+    swagger_types = {
+        'filter': 'union[str,object]',
+        'view': 'FilterView',
+        'origin': 'Origin',
+        'created': 'datetime',
+        'modified': 'datetime',
+        'deleted': 'datetime',
+        'id': 'str',
+        'label': 'str'
+    }
+
+    attribute_map = {
+        'filter': 'filter',
+        'view': 'view',
+        'origin': 'origin',
+        'created': 'created',
+        'modified': 'modified',
+        'deleted': 'deleted',
+        'id': '_id',
+        'label': 'label'
+    }
+
+    rattribute_map = {
+        'filter': 'filter',
+        'view': 'view',
+        'origin': 'origin',
+        'created': 'created',
+        'modified': 'modified',
+        'deleted': 'deleted',
+        '_id': 'id',
+        'label': 'label'
+    }
+
+    def __init__(self, filter=None, view=None, origin=None, created=None, modified=None, deleted=None, id=None, label=None):  # noqa: E501
+        """CoreModelsCustomFiltersFilter - a model defined in Swagger"""
+        super(CoreModelsCustomFiltersFilter, self).__init__()
+
+        self._filter = None
+        self._view = None
+        self._origin = None
+        self._created = None
+        self._modified = None
+        self._deleted = None
+        self._id = None
+        self._label = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        self.filter = filter
+        self.view = view
+        self.origin = origin
+        self.created = created
+        self.modified = modified
+        if deleted is not None:
+            self.deleted = deleted
+        self.id = id
+        self.label = label
+
+    @property
+    def filter(self):
+        """Gets the filter of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The filter of this CoreModelsCustomFiltersFilter.
+        :rtype: union[str,object]
+        """
+        return self._filter
+
+    @filter.setter
+    def filter(self, filter):
+        """Sets the filter of this CoreModelsCustomFiltersFilter.
+
+
+        :param filter: The filter of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: union[str,object]
+        """
+
+        self._filter = filter
+
+    @property
+    def view(self):
+        """Gets the view of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The view of this CoreModelsCustomFiltersFilter.
+        :rtype: FilterView
+        """
+        return self._view
+
+    @view.setter
+    def view(self, view):
+        """Sets the view of this CoreModelsCustomFiltersFilter.
+
+
+        :param view: The view of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: FilterView
+        """
+
+        self._view = view
+
+    @property
+    def origin(self):
+        """Gets the origin of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The origin of this CoreModelsCustomFiltersFilter.
+        :rtype: Origin
+        """
+        return self._origin
+
+    @origin.setter
+    def origin(self, origin):
+        """Sets the origin of this CoreModelsCustomFiltersFilter.
+
+
+        :param origin: The origin of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: Origin
+        """
+
+        self._origin = origin
+
+    @property
+    def created(self):
+        """Gets the created of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The created of this CoreModelsCustomFiltersFilter.
+        :rtype: datetime
+        """
+        return self._created
+
+    @created.setter
+    def created(self, created):
+        """Sets the created of this CoreModelsCustomFiltersFilter.
+
+
+        :param created: The created of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: datetime
+        """
+
+        self._created = created
+
+    @property
+    def modified(self):
+        """Gets the modified of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The modified of this CoreModelsCustomFiltersFilter.
+        :rtype: datetime
+        """
+        return self._modified
+
+    @modified.setter
+    def modified(self, modified):
+        """Sets the modified of this CoreModelsCustomFiltersFilter.
+
+
+        :param modified: The modified of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: datetime
+        """
+
+        self._modified = modified
+
+    @property
+    def deleted(self):
+        """Gets the deleted of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The deleted of this CoreModelsCustomFiltersFilter.
+        :rtype: datetime
+        """
+        return self._deleted
+
+    @deleted.setter
+    def deleted(self, deleted):
+        """Sets the deleted of this CoreModelsCustomFiltersFilter.
+
+
+        :param deleted: The deleted of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: datetime
+        """
+
+        self._deleted = deleted
+
+    @property
+    def id(self):
+        """Gets the id of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The id of this CoreModelsCustomFiltersFilter.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this CoreModelsCustomFiltersFilter.
+
+
+        :param id: The id of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: str
+        """
+
+        self._id = id
+
+    @property
+    def label(self):
+        """Gets the label of this CoreModelsCustomFiltersFilter.
+
+
+        :return: The label of this CoreModelsCustomFiltersFilter.
+        :rtype: str
+        """
+        return self._label
+
+    @label.setter
+    def label(self, label):
+        """Sets the label of this CoreModelsCustomFiltersFilter.
+
+
+        :param label: The label of this CoreModelsCustomFiltersFilter.  # noqa: E501
+        :type: str
+        """
+
+        self._label = label
+
+
+    @staticmethod
+    def positional_to_model(value):
+        """Converts a positional argument to a model value"""
+        return value
+
+    def return_value(self):
+        """Unwraps return value from model"""
+        return self
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, CoreModelsCustomFiltersFilter):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other
+
+    # Container emulation
+    def __getitem__(self, key):
+        """Returns the value of key"""
+        key = self._map_key(key)
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        """Sets the value of key"""
+        key = self._map_key(key)
+        setattr(self, key, value)
+
+    def __contains__(self, key):
+        """Checks if the given value is a key in this object"""
+        key = self._map_key(key, raise_on_error=False)
+        return key is not None
+
+    def keys(self):
+        """Returns the list of json properties in the object"""
+        return self.__class__.rattribute_map.keys()
+
+    def values(self):
+        """Returns the list of values in the object"""
+        for key in self.__class__.attribute_map.keys():
+            yield getattr(self, key)
+
+    def items(self):
+        """Returns the list of json property to value mapping"""
+        for key, prop in self.__class__.rattribute_map.items():
+            yield key, getattr(self, prop)
+
+    def get(self, key, default=None):
+        """Get the value of the provided json property, or default"""
+        key = self._map_key(key, raise_on_error=False)
+        if key:
+            return getattr(self, key, default)
+        return default
+
+    def _map_key(self, key, raise_on_error=True):
+        result = self.__class__.rattribute_map.get(key)
+        if result is None:
+            if raise_on_error:
+                raise AttributeError('Invalid attribute name: {}'.format(key))
+            return None
+        return '_' + result