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

flywheel/api/tasks_api.py

@@ -30,13 +30,10 @@ class TasksApi(object):
         Assign a user or staffing pool to reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param body:
-        :type body: TaskAssign
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTaskOutput
+        :param str task_id: (required)
+        :param TaskAssign body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTaskOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -60,13 +57,10 @@ class TasksApi(object):
         Assign a user or staffing pool to reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param body:
-        :type body: TaskAssign
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTaskOutput
+        :param str task_id: (required)
+        :param TaskAssign body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTaskOutput
         """
 
         all_params = ['task_id','body',]  # noqa: E501
@@ -152,11 +146,9 @@ class TasksApi(object):
         Create a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ReaderBatchCreate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ReaderTask]
+        :param ReaderBatchCreate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[ReaderTask]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -180,11 +172,9 @@ class TasksApi(object):
         Create a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ReaderBatchCreate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ReaderTask]
+        :param ReaderBatchCreate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[ReaderTask]
         """
 
         all_params = ['body',]  # noqa: E501
@@ -264,13 +254,10 @@ class TasksApi(object):
         Complete a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param body:
-        :type body: TaskSubmission, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTask
+        :param str task_id: (required)
+        :param TaskSubmission body:
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTask
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -294,13 +281,10 @@ class TasksApi(object):
         Complete a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param body:
-        :type body: TaskSubmission, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTask
+        :param str task_id: (required)
+        :param TaskSubmission body:
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTask
         """
 
         all_params = ['task_id','body',]  # noqa: E501
@@ -382,11 +366,9 @@ class TasksApi(object):
         Create a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ReaderTaskCreate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTask
+        :param ReaderTaskCreate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTask
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -410,11 +392,9 @@ class TasksApi(object):
         Create a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ReaderTaskCreate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTask
+        :param ReaderTaskCreate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTask
         """
 
         all_params = ['body',]  # noqa: E501
@@ -493,17 +473,12 @@ class TasksApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param limit:, defaults to 10
-        :type limit: int, optional
-        :param skip:, defaults to 0
-        :type skip: int, optional
-        :param filter:
-        :type filter: str, optional
-        :param sort:
-        :type sort: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: PageGenericReaderTaskOutput
+        :param int limit:
+        :param int skip:
+        :param str filter:
+        :param str sort:
+        :param bool async_: Perform the request asynchronously
+        :return: PageGenericReaderTaskOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -526,17 +501,12 @@ class TasksApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param limit:, defaults to 10
-        :type limit: int, optional
-        :param skip:, defaults to 0
-        :type skip: int, optional
-        :param filter:
-        :type filter: str, optional
-        :param sort:
-        :type sort: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: PageGenericReaderTaskOutput
+        :param int limit:
+        :param int skip:
+        :param str filter:
+        :param str sort:
+        :param bool async_: Perform the request asynchronously
+        :return: PageGenericReaderTaskOutput
         """
 
         all_params = ['limit','skip','filter','sort',]  # noqa: E501
@@ -607,13 +577,10 @@ class TasksApi(object):
         Get facet counts for a specific field in reader tasks.
         This method makes a synchronous HTTP request by default.
 
-        :param facet_field:
-        :type facet_field: TaskFacet
-        :param filter:
-        :type filter: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, int)
+        :param TaskFacet facet_field: (required)
+        :param str filter:
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, int)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -637,13 +604,10 @@ class TasksApi(object):
         Get facet counts for a specific field in reader tasks.
         This method makes a synchronous HTTP request by default.
 
-        :param facet_field:
-        :type facet_field: TaskFacet
-        :param filter:
-        :type filter: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, int)
+        :param TaskFacet facet_field: (required)
+        :param str filter:
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, int)
         """
 
         all_params = ['facet_field','filter',]  # noqa: E501
@@ -714,11 +678,9 @@ class TasksApi(object):
         Get reader task by id.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTaskOutput
+        :param str task_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTaskOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -742,11 +704,9 @@ class TasksApi(object):
         Get reader task by id.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTaskOutput
+        :param str task_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTaskOutput
         """
 
         all_params = ['task_id',]  # noqa: E501
@@ -815,13 +775,10 @@ class TasksApi(object):
         Modify a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param body:
-        :type body: ReaderTaskModify
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTaskOutput
+        :param str task_id: (required)
+        :param ReaderTaskModify body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTaskOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -845,13 +802,10 @@ class TasksApi(object):
         Modify a reader task.
         This method makes a synchronous HTTP request by default.
 
-        :param task_id:
-        :type task_id: str
-        :param body:
-        :type body: ReaderTaskModify
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReaderTaskOutput
+        :param str task_id: (required)
+        :param ReaderTaskModify body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ReaderTaskOutput
         """
 
         all_params = ['task_id','body',]  # noqa: E501

flywheel/api/tree_api.py

@@ -30,29 +30,18 @@ class TreeApi(object):
         This is a build-your-own request endpoint that can fetch from anywhere in the hierarchy, returning just the fields that you care about.  # Fields Each fetch-level described must include a list of fields to return. These fields can be anything on the container (except info), and will be included in the response if they are present in the container.  # Joins Children or parents can be joined as part of this request, by specifying an additional subdocument of the given name. Check /tree/graph for a list of containers and their connections.  # Filter Joined documents can be further filtered (with the exception of inputs & files) by passing a filter in the subdocument. Filtering follows the same convention as top-level pagination.  # Sort Joined documents can be sorted as well, following the convention as top-level pagination.  # Limit Joins can be limited to a the first N documents by specifying a limit in the subdocument.  # Join-origin Passing `true` for the `join-origin` flag in the files subdocument will populates the `join-origin` map for each container with files.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: GraphFilter
-        :param exhaustive:, defaults to false
-        :type exhaustive: bool, optional
-        :param include_all_info: Include all info in returned objects, defaults to false
-        :type include_all_info: bool, optional
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param x_accept_feature:, defaults to []
-        :type x_accept_feature: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[Page,list[object]]
+        :param GraphFilter body: (required)
+        :param bool exhaustive:
+        :param bool include_all_info: Include all info in returned objects
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (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[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[Page,list[object]]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -76,29 +65,18 @@ class TreeApi(object):
         This is a build-your-own request endpoint that can fetch from anywhere in the hierarchy, returning just the fields that you care about.  # Fields Each fetch-level described must include a list of fields to return. These fields can be anything on the container (except info), and will be included in the response if they are present in the container.  # Joins Children or parents can be joined as part of this request, by specifying an additional subdocument of the given name. Check /tree/graph for a list of containers and their connections.  # Filter Joined documents can be further filtered (with the exception of inputs & files) by passing a filter in the subdocument. Filtering follows the same convention as top-level pagination.  # Sort Joined documents can be sorted as well, following the convention as top-level pagination.  # Limit Joins can be limited to a the first N documents by specifying a limit in the subdocument.  # Join-origin Passing `true` for the `join-origin` flag in the files subdocument will populates the `join-origin` map for each container with files.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: GraphFilter
-        :param exhaustive:, defaults to false
-        :type exhaustive: bool, optional
-        :param include_all_info: Include all info in returned objects, defaults to false
-        :type include_all_info: bool, optional
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param x_accept_feature:, defaults to []
-        :type x_accept_feature: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[Page,list[object]]
+        :param GraphFilter body: (required)
+        :param bool exhaustive:
+        :param bool include_all_info: Include all info in returned objects
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (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[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[Page,list[object]]
         """
 
         all_params = ['body','exhaustive','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -197,9 +175,8 @@ class TreeApi(object):
         Get a description of the flywheel hiearchy
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, TreeGraphNode)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, TreeGraphNode)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -223,9 +200,8 @@ class TreeApi(object):
         Get a description of the flywheel hiearchy
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, TreeGraphNode)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, TreeGraphNode)
         """
 
         all_params = []  # noqa: E501

flywheel/api/uids_api.py

@@ -30,11 +30,9 @@ class UidsApi(object):
         Check if any of the given list of UIDs exist in the system
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: union[UidCheckInputSessions,UidCheckInputAcquisitions]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: UidCheckOutput
+        :param union[UidCheckInputSessions,UidCheckInputAcquisitions] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: UidCheckOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class UidsApi(object):
         Check if any of the given list of UIDs exist in the system
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: union[UidCheckInputSessions,UidCheckInputAcquisitions]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: UidCheckOutput
+        :param union[UidCheckInputSessions,UidCheckInputAcquisitions] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: UidCheckOutput
         """
 
         all_params = ['body',]  # noqa: E501