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

flywheel/api/audit_trail_api.py

@@ -30,11 +30,9 @@ class AuditTrailApi(object):
         Start generation of a new Audit Trail Report.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: CoreModelsAuditTrailCreateReportInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: AuditTrailReport
+        :param CoreModelsAuditTrailCreateReportInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: AuditTrailReport
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class AuditTrailApi(object):
         Start generation of a new Audit Trail Report.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: CoreModelsAuditTrailCreateReportInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: AuditTrailReport
+        :param CoreModelsAuditTrailCreateReportInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: AuditTrailReport
         """
 
         all_params = ['body',]  # noqa: E501
@@ -142,11 +138,9 @@ class AuditTrailApi(object):
         Delete an Audit Trail Report
         This method makes a synchronous HTTP request by default.
 
-        :param report_id:
-        :type report_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: DeletedResult
+        :param str report_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -170,11 +164,9 @@ class AuditTrailApi(object):
         Delete an Audit Trail Report
         This method makes a synchronous HTTP request by default.
 
-        :param report_id:
-        :type report_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: DeletedResult
+        :param str report_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
         """
 
         all_params = ['report_id',]  # noqa: E501
@@ -243,11 +235,9 @@ class AuditTrailApi(object):
         Download Audit Trail Reports
         This method makes a synchronous HTTP request by default.
 
-        :param report_id:
-        :type report_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str report_id: (required)
+        :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
@@ -271,11 +261,9 @@ class AuditTrailApi(object):
         Download Audit Trail Reports
         This method makes a synchronous HTTP request by default.
 
-        :param report_id:
-        :type report_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str report_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['report_id',]  # noqa: E501
@@ -344,23 +332,15 @@ class AuditTrailApi(object):
         List Audit Trail Reports.
         This method makes a synchronous HTTP request by default.
 
-        :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[union[HeaderFeature,str]], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[Page,list[AuditTrailReport]]
+        :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[union[HeaderFeature,str]] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[Page,list[AuditTrailReport]]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -384,23 +364,15 @@ class AuditTrailApi(object):
         List Audit Trail Reports.
         This method makes a synchronous HTTP request by default.
 
-        :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[union[HeaderFeature,str]], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[Page,list[AuditTrailReport]]
+        :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[union[HeaderFeature,str]] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[Page,list[AuditTrailReport]]
         """
 
         all_params = ['filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -478,13 +450,10 @@ class AuditTrailApi(object):
         Modify an Audit Trail Report
         This method makes a synchronous HTTP request by default.
 
-        :param report_id:
-        :type report_id: str
-        :param body:
-        :type body: CoreModelsAuditTrailModifyReportInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: AuditTrailReport
+        :param str report_id: (required)
+        :param CoreModelsAuditTrailModifyReportInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: AuditTrailReport
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -508,13 +477,10 @@ class AuditTrailApi(object):
         Modify an Audit Trail Report
         This method makes a synchronous HTTP request by default.
 
-        :param report_id:
-        :type report_id: str
-        :param body:
-        :type body: CoreModelsAuditTrailModifyReportInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: AuditTrailReport
+        :param str report_id: (required)
+        :param CoreModelsAuditTrailModifyReportInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: AuditTrailReport
         """
 
         all_params = ['report_id','body',]  # noqa: E501

flywheel/api/auth_api.py

@@ -30,9 +30,8 @@ class AuthApi(object):
         Get the current login status of the requestor
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: AuthSessionOutput
+        :param bool async_: Perform the request asynchronously
+        :return: AuthSessionOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -56,9 +55,8 @@ class AuthApi(object):
         Get the current login status of the requestor
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: AuthSessionOutput
+        :param bool async_: Perform the request asynchronously
+        :return: AuthSessionOutput
         """
 
         all_params = []  # noqa: E501

flywheel/api/batch_api.py

@@ -30,11 +30,9 @@ class BatchApi(object):
         Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'.
         This method makes a synchronous HTTP request by default.
 
-        :param batch_id:
-        :type batch_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: CancelledBatchOutput
+        :param str batch_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: CancelledBatchOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class BatchApi(object):
         Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'.
         This method makes a synchronous HTTP request by default.
 
-        :param batch_id:
-        :type batch_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: CancelledBatchOutput
+        :param str batch_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: CancelledBatchOutput
         """
 
         all_params = ['batch_id',]  # noqa: E501
@@ -131,11 +127,9 @@ class BatchApi(object):
         Create a batch job proposal from preconstructed jobs and insert it as 'pending'.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: PremadeJobsBatchProposalInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: PremadeJobsBatchProposal
+        :param PremadeJobsBatchProposalInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: PremadeJobsBatchProposal
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -159,11 +153,9 @@ class BatchApi(object):
         Create a batch job proposal from preconstructed jobs and insert it as 'pending'.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: PremadeJobsBatchProposalInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: PremadeJobsBatchProposal
+        :param PremadeJobsBatchProposalInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: PremadeJobsBatchProposal
         """
 
         all_params = ['body',]  # noqa: E501
@@ -243,9 +235,8 @@ class BatchApi(object):
         Requires login.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[Batch]
+        :param bool async_: Perform the request asynchronously
+        :return: list[Batch]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -269,9 +260,8 @@ class BatchApi(object):
         Requires login.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[Batch]
+        :param bool async_: Perform the request asynchronously
+        :return: list[Batch]
         """
 
         all_params = []  # noqa: E501
@@ -333,13 +323,10 @@ class BatchApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param batch_id:
-        :type batch_id: str
-        :param jobs: If true, return job objects instead of job ids, defaults to false
-        :type jobs: bool, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[ClassicBatchJobOutput,ClassicBatchJobOutputInflatedJobs,PremadeJobsBatchJobOutput,PremadeJobsBatchJobOutputInflatedJobs]
+        :param str batch_id: (required)
+        :param bool jobs: If true, return job objects instead of job ids
+        :param bool async_: Perform the request asynchronously
+        :return: union[ClassicBatchJobOutput,ClassicBatchJobOutputInflatedJobs,PremadeJobsBatchJobOutput,PremadeJobsBatchJobOutputInflatedJobs]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -362,13 +349,10 @@ class BatchApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param batch_id:
-        :type batch_id: str
-        :param jobs: If true, return job objects instead of job ids, defaults to false
-        :type jobs: bool, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[ClassicBatchJobOutput,ClassicBatchJobOutputInflatedJobs,PremadeJobsBatchJobOutput,PremadeJobsBatchJobOutputInflatedJobs]
+        :param str batch_id: (required)
+        :param bool jobs: If true, return job objects instead of job ids
+        :param bool async_: Perform the request asynchronously
+        :return: union[ClassicBatchJobOutput,ClassicBatchJobOutputInflatedJobs,PremadeJobsBatchJobOutput,PremadeJobsBatchJobOutputInflatedJobs]
         """
 
         all_params = ['batch_id','jobs',]  # noqa: E501
@@ -439,11 +423,9 @@ class BatchApi(object):
         Create a batch job proposal and insert it as 'pending'.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ClassicBatchProposalInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ClassicBatchProposalOutput
+        :param ClassicBatchProposalInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ClassicBatchProposalOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -467,11 +449,9 @@ class BatchApi(object):
         Create a batch job proposal and insert it as 'pending'.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ClassicBatchProposalInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ClassicBatchProposalOutput
+        :param ClassicBatchProposalInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ClassicBatchProposalOutput
         """
 
         all_params = ['body',]  # noqa: E501
@@ -551,11 +531,9 @@ class BatchApi(object):
         Creates jobs from proposed inputs, returns jobs enqueued. Moves 'pending' batch job to 'running'.
         This method makes a synchronous HTTP request by default.
 
-        :param batch_id:
-        :type batch_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[JobOutput]
+        :param str batch_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[JobOutput]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -579,11 +557,9 @@ class BatchApi(object):
         Creates jobs from proposed inputs, returns jobs enqueued. Moves 'pending' batch job to 'running'.
         This method makes a synchronous HTTP request by default.
 
-        :param batch_id:
-        :type batch_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[JobOutput]
+        :param str batch_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[JobOutput]
         """
 
         all_params = ['batch_id',]  # noqa: E501

flywheel/api/bulk_api.py

@@ -30,11 +30,9 @@ class BulkApi(object):
         Move sessions
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: BulkMoveInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[MoveConflict]
+        :param BulkMoveInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[MoveConflict]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class BulkApi(object):
         Move sessions
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: BulkMoveInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[MoveConflict]
+        :param BulkMoveInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[MoveConflict]
         """
 
         all_params = ['body',]  # noqa: E501

flywheel/api/change_log_api.py

@@ -29,15 +29,11 @@ class ChangeLogApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param container_type:
-        :type container_type: ChangeLogContainerType
-        :param container_id:
-        :type container_id: str
-        :param version: Optional version if retrieving logs for file
-        :type version: int, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ChangeLogDocument
+        :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
@@ -60,15 +56,11 @@ class ChangeLogApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param container_type:
-        :type container_type: ChangeLogContainerType
-        :param container_id:
-        :type container_id: str
-        :param version: Optional version if retrieving logs for file
-        :type version: int, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ChangeLogDocument
+        :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
@@ -144,17 +136,12 @@ class ChangeLogApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param container_type:
-        :type container_type: ChangeLogContainerType
-        :param container_id:
-        :type container_id: str
-        :param field:
-        :type field: str
-        :param version: Optional version if retrieving logs for file
-        :type version: int, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: FieldChangeLogDocument
+        :param ChangeLogContainerType container_type: (required)
+        :param str container_id: (required)
+        :param str field: (required)
+        :param int version: Optional version if retrieving logs for file
+        :param bool async_: Perform the request asynchronously
+        :return: FieldChangeLogDocument
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -177,17 +164,12 @@ class ChangeLogApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param container_type:
-        :type container_type: ChangeLogContainerType
-        :param container_id:
-        :type container_id: str
-        :param field:
-        :type field: str
-        :param version: Optional version if retrieving logs for file
-        :type version: int, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: FieldChangeLogDocument
+        :param ChangeLogContainerType container_type: (required)
+        :param str container_id: (required)
+        :param str field: (required)
+        :param int version: Optional version if retrieving logs for file
+        :param bool async_: Perform the request asynchronously
+        :return: FieldChangeLogDocument
         """
 
         all_params = ['container_type','container_id','field','version',]  # noqa: E501