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

flywheel/api/reports_api.py

@@ -30,15 +30,11 @@ class ReportsApi(object):
         Collects usage statistics for the selected day (or yesterday if no day is given)
         This method makes a synchronous HTTP request by default.
 
-        :param year: The year portion of the date
-        :type year: int, optional
-        :param month: The month portion of the date
-        :type month: int, optional
-        :param day: The day portion of the date
-        :type day: int, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param int year: The year portion of the date
+        :param int month: The month portion of the date
+        :param int day: The day portion of the date
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -62,15 +58,11 @@ class ReportsApi(object):
         Collects usage statistics for the selected day (or yesterday if no day is given)
         This method makes a synchronous HTTP request by default.
 
-        :param year: The year portion of the date
-        :type year: int, optional
-        :param month: The month portion of the date
-        :type month: int, optional
-        :param day: The day portion of the date
-        :type day: int, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param int year: The year portion of the date
+        :param int month: The month portion of the date
+        :param int day: The day portion of the date
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['year','month','day',]  # noqa: E501
@@ -138,37 +130,22 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param csv: Set to download a csv file instead of json, defaults to false
-        :type csv: 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, defaults to 100
-        :type limit: int, optional
-        :param skip: The number of entries to skip
-        :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 start_date: An ISO formatted timestamp for the start time of the report
-        :type start_date: datetime, optional
-        :param end_date: An ISO formatted timestamp for the end time of the report
-        :type end_date: datetime, optional
-        :param user: User id of the target user
-        :type user: str, optional
-        :param subject: Limit the report to the subject code of subject accessed
-        :type subject: str, optional
-        :param project: Limit the report to the project id
-        :type project: str, optional
-        :param access_types: The list of access_types to filter logs
-        :type access_types: list[AccessType], 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: list[ReportAccessLogEntry]
+        :param bool csv: Set to download a csv file instead of json
+        :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 datetime start_date: An ISO formatted timestamp for the start time of the report
+        :param datetime end_date: An ISO formatted timestamp for the end time of the report
+        :param str user: User id of the target user
+        :param str subject: Limit the report to the subject code of subject accessed
+        :param str project: Limit the report to the project id
+        :param list[AccessType] access_types: The list of access_types to filter logs
+        :param list[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: list[ReportAccessLogEntry]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -191,37 +168,22 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param csv: Set to download a csv file instead of json, defaults to false
-        :type csv: 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, defaults to 100
-        :type limit: int, optional
-        :param skip: The number of entries to skip
-        :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 start_date: An ISO formatted timestamp for the start time of the report
-        :type start_date: datetime, optional
-        :param end_date: An ISO formatted timestamp for the end time of the report
-        :type end_date: datetime, optional
-        :param user: User id of the target user
-        :type user: str, optional
-        :param subject: Limit the report to the subject code of subject accessed
-        :type subject: str, optional
-        :param project: Limit the report to the project id
-        :type project: str, optional
-        :param access_types: The list of access_types to filter logs
-        :type access_types: list[AccessType], 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: list[ReportAccessLogEntry]
+        :param bool csv: Set to download a csv file instead of json
+        :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 datetime start_date: An ISO formatted timestamp for the start time of the report
+        :param datetime end_date: An ISO formatted timestamp for the end time of the report
+        :param str user: User id of the target user
+        :param str subject: Limit the report to the subject code of subject accessed
+        :param str project: Limit the report to the project id
+        :param list[AccessType] access_types: The list of access_types to filter logs
+        :param list[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: list[ReportAccessLogEntry]
         """
 
         all_params = ['csv','filter','sort','limit','skip','page','after_id','start_date','end_date','user','subject','project','access_types','x_accept_feature',]  # noqa: E501
@@ -313,9 +275,8 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[str]
+        :param bool async_: Perform the request asynchronously
+        :return: list[str]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -338,9 +299,8 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[str]
+        :param bool async_: Perform the request asynchronously
+        :return: list[str]
         """
 
         all_params = []  # noqa: E501
@@ -402,17 +362,12 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param start_date: An ISO formatted timestamp for the start time of the report
-        :type start_date: datetime, optional
-        :param end_date: An ISO formatted timestamp for the end time of the report
-        :type end_date: datetime, optional
-        :param group: Limit the report to the given group id
-        :type group: str, optional
-        :param project: Limit the report to the given project id
-        :type project: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[DailyReportUsage]
+        :param datetime start_date: An ISO formatted timestamp for the start time of the report
+        :param datetime end_date: An ISO formatted timestamp for the end time of the report
+        :param str group: Limit the report to the given group id
+        :param str project: Limit the report to the given project id
+        :param bool async_: Perform the request asynchronously
+        :return: list[DailyReportUsage]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -435,17 +390,12 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param start_date: An ISO formatted timestamp for the start time of the report
-        :type start_date: datetime, optional
-        :param end_date: An ISO formatted timestamp for the end time of the report
-        :type end_date: datetime, optional
-        :param group: Limit the report to the given group id
-        :type group: str, optional
-        :param project: Limit the report to the given project id
-        :type project: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[DailyReportUsage]
+        :param datetime start_date: An ISO formatted timestamp for the start time of the report
+        :param datetime end_date: An ISO formatted timestamp for the end time of the report
+        :param str group: Limit the report to the given group id
+        :param str project: Limit the report to the given project id
+        :param bool async_: Perform the request asynchronously
+        :return: list[DailyReportUsage]
         """
 
         all_params = ['start_date','end_date','group','project',]  # noqa: E501
@@ -516,17 +466,12 @@ class ReportsApi(object):
         If no year/month pair is given, the current month will be used.
         This method makes a synchronous HTTP request by default.
 
-        :param year: The year portion of the date
-        :type year: int, optional
-        :param month: The month portion of the date
-        :type month: int, optional
-        :param group: Limit the report to the given group id
-        :type group: str, optional
-        :param project: Limit the report to the given project id
-        :type project: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[DailyReportUsage]
+        :param int year: The year portion of the date
+        :param int month: The month portion of the date
+        :param str group: Limit the report to the given group id
+        :param str project: Limit the report to the given project id
+        :param bool async_: Perform the request asynchronously
+        :return: list[DailyReportUsage]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -550,17 +495,12 @@ class ReportsApi(object):
         If no year/month pair is given, the current month will be used.
         This method makes a synchronous HTTP request by default.
 
-        :param year: The year portion of the date
-        :type year: int, optional
-        :param month: The month portion of the date
-        :type month: int, optional
-        :param group: Limit the report to the given group id
-        :type group: str, optional
-        :param project: Limit the report to the given project id
-        :type project: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[DailyReportUsage]
+        :param int year: The year portion of the date
+        :param int month: The month portion of the date
+        :param str group: Limit the report to the given group id
+        :param str project: Limit the report to the given project id
+        :param bool async_: Perform the request asynchronously
+        :return: list[DailyReportUsage]
         """
 
         all_params = ['year','month','group','project',]  # noqa: E501
@@ -631,15 +571,11 @@ class ReportsApi(object):
         This report is DEPRECATED and will be removed in a future release
         This method makes a synchronous HTTP request by default.
 
-        :param type: The type of usage report to generate
-        :type type: str
-        :param start_date: An ISO formatted timestamp for the start time of the report
-        :type start_date: datetime, optional
-        :param end_date: An ISO formatted timestamp for the end time of the report
-        :type end_date: datetime, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[LegacyUsageReport]
+        :param str type: The type of usage report to generate (required)
+        :param datetime start_date: An ISO formatted timestamp for the start time of the report
+        :param datetime end_date: An ISO formatted timestamp for the end time of the report
+        :param bool async_: Perform the request asynchronously
+        :return: list[LegacyUsageReport]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -663,15 +599,11 @@ class ReportsApi(object):
         This report is DEPRECATED and will be removed in a future release
         This method makes a synchronous HTTP request by default.
 
-        :param type: The type of usage report to generate
-        :type type: str
-        :param start_date: An ISO formatted timestamp for the start time of the report
-        :type start_date: datetime, optional
-        :param end_date: An ISO formatted timestamp for the end time of the report
-        :type end_date: datetime, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[LegacyUsageReport]
+        :param str type: The type of usage report to generate (required)
+        :param datetime start_date: An ISO formatted timestamp for the start time of the report
+        :param datetime end_date: An ISO formatted timestamp for the end time of the report
+        :param bool async_: Perform the request asynchronously
+        :return: list[LegacyUsageReport]
         """
 
         all_params = ['type','start_date','end_date',]  # noqa: E501
@@ -744,15 +676,11 @@ class ReportsApi(object):
         Get project report
         This method makes a synchronous HTTP request by default.
 
-        :param projects: Specify multiple times to include projects in the report
-        :type projects: list[str], optional
-        :param start_date: Report start date
-        :type start_date: datetime, optional
-        :param end_date: Report end date
-        :type end_date: datetime, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ProjectReportList
+        :param list[str] projects: Specify multiple times to include projects in the report
+        :param datetime start_date: Report start date
+        :param datetime end_date: Report end date
+        :param bool async_: Perform the request asynchronously
+        :return: ProjectReportList
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -776,15 +704,11 @@ class ReportsApi(object):
         Get project report
         This method makes a synchronous HTTP request by default.
 
-        :param projects: Specify multiple times to include projects in the report
-        :type projects: list[str], optional
-        :param start_date: Report start date
-        :type start_date: datetime, optional
-        :param end_date: Report end date
-        :type end_date: datetime, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ProjectReportList
+        :param list[str] projects: Specify multiple times to include projects in the report
+        :param datetime start_date: Report start date
+        :param datetime end_date: Report end date
+        :param bool async_: Perform the request asynchronously
+        :return: ProjectReportList
         """
 
         all_params = ['projects','start_date','end_date',]  # noqa: E501
@@ -853,9 +777,8 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SiteReport
+        :param bool async_: Perform the request asynchronously
+        :return: SiteReport
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -878,9 +801,8 @@ class ReportsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SiteReport
+        :param bool async_: Perform the request asynchronously
+        :return: SiteReport
         """
 
         all_params = []  # noqa: E501
@@ -943,9 +865,8 @@ class ReportsApi(object):
         Get year/month combinations where report data is available. Returns:     Returns the list of months where report data is available
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReportAvailabilityList
+        :param bool async_: Perform the request asynchronously
+        :return: ReportAvailabilityList
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -969,9 +890,8 @@ class ReportsApi(object):
         Get year/month combinations where report data is available. Returns:     Returns the list of months where report data is available
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ReportAvailabilityList
+        :param bool async_: Perform the request asynchronously
+        :return: ReportAvailabilityList
         """
 
         all_params = []  # noqa: E501
@@ -1034,15 +954,11 @@ class ReportsApi(object):
         If no year/month pair is given, the current month will be used.
         This method makes a synchronous HTTP request by default.
 
-        :param year: The year portion of the date
-        :type year: int, optional
-        :param month: The month portion of the date
-        :type month: int, optional
-        :param project: Project to filter to
-        :type project: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ReportUsage]
+        :param int year: The year portion of the date
+        :param int month: The month portion of the date
+        :param str project: Project to filter to
+        :param bool async_: Perform the request asynchronously
+        :return: list[ReportUsage]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1066,15 +982,11 @@ class ReportsApi(object):
         If no year/month pair is given, the current month will be used.
         This method makes a synchronous HTTP request by default.
 
-        :param year: The year portion of the date
-        :type year: int, optional
-        :param month: The month portion of the date
-        :type month: int, optional
-        :param project: Project to filter to
-        :type project: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ReportUsage]
+        :param int year: The year portion of the date
+        :param int month: The month portion of the date
+        :param str project: Project to filter to
+        :param bool async_: Perform the request asynchronously
+        :return: list[ReportUsage]
         """
 
         all_params = ['year','month','project',]  # noqa: E501

flywheel/api/resolve_api.py

@@ -30,17 +30,12 @@ class ResolveApi(object):
         This will perform a deep lookup of a node. See /resolve for more details.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ResolveInput
-        :param full_tree:, defaults to false
-        :type full_tree: bool, optional
-        :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 async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ResolverNode
+        :param ResolveInput body: (required)
+        :param bool full_tree:
+        :param bool exhaustive:
+        :param bool include_all_info: Include all info in returned objects
+        :param bool async_: Perform the request asynchronously
+        :return: ResolverNode
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -64,17 +59,12 @@ class ResolveApi(object):
         This will perform a deep lookup of a node. See /resolve for more details.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ResolveInput
-        :param full_tree:, defaults to false
-        :type full_tree: bool, optional
-        :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 async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ResolverNode
+        :param ResolveInput body: (required)
+        :param bool full_tree:
+        :param bool exhaustive:
+        :param bool include_all_info: Include all info in returned objects
+        :param bool async_: Perform the request asynchronously
+        :return: ResolverNode
         """
 
         all_params = ['body','full_tree','exhaustive','include_all_info',]  # noqa: E501
@@ -160,19 +150,13 @@ class ResolveApi(object):
         This will perform a deep lookup of a node (i.e. group/project/session/acquisition) and its children, including any files. The query path is an array of strings in the following order (by default):    * group id   * project label   * session label   * acquisition label  Additionally, analyses for project/session/acquisition nodes can be resolved by inserting the literal string `\"analyses\"`. e.g. `['scitran', 'MyProject', 'analyses']`.  Files for projects, sessions, acquisitions and analyses can be resolved by inserting the literal string `\"files\"`. e.g. `['scitran', 'MyProject', 'files']`.  An ID can be used instead of a label by formatting the string as `<id:project_id>`. The full path to the node, and the node's children will be included in the response.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ResolveInput
-        :param full_tree: Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...), defaults to false
-        :type full_tree: bool, optional
-        :param minattr: Return only minimal attributes, defaults to false
-        :type minattr: bool, optional
-        :param exhaustive: Set to return a complete list regardless of permissions, 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 async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ResolveOutput
+        :param ResolveInput body: (required)
+        :param bool full_tree: Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...)
+        :param bool minattr: Return only minimal attributes
+        :param bool exhaustive: Set to return a complete list regardless of permissions
+        :param bool include_all_info: Include all info in returned objects
+        :param bool async_: Perform the request asynchronously
+        :return: ResolveOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -196,19 +180,13 @@ class ResolveApi(object):
         This will perform a deep lookup of a node (i.e. group/project/session/acquisition) and its children, including any files. The query path is an array of strings in the following order (by default):    * group id   * project label   * session label   * acquisition label  Additionally, analyses for project/session/acquisition nodes can be resolved by inserting the literal string `\"analyses\"`. e.g. `['scitran', 'MyProject', 'analyses']`.  Files for projects, sessions, acquisitions and analyses can be resolved by inserting the literal string `\"files\"`. e.g. `['scitran', 'MyProject', 'files']`.  An ID can be used instead of a label by formatting the string as `<id:project_id>`. The full path to the node, and the node's children will be included in the response.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ResolveInput
-        :param full_tree: Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...), defaults to false
-        :type full_tree: bool, optional
-        :param minattr: Return only minimal attributes, defaults to false
-        :type minattr: bool, optional
-        :param exhaustive: Set to return a complete list regardless of permissions, 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 async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ResolveOutput
+        :param ResolveInput body: (required)
+        :param bool full_tree: Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...)
+        :param bool minattr: Return only minimal attributes
+        :param bool exhaustive: Set to return a complete list regardless of permissions
+        :param bool include_all_info: Include all info in returned objects
+        :param bool async_: Perform the request asynchronously
+        :return: ResolveOutput
         """
 
         all_params = ['body','full_tree','minattr','exhaustive','include_all_info',]  # noqa: E501