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

flywheel/api/upload_api.py

@@ -1,13 +1,6 @@
 # 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
 """
 
 
@@ -36,9 +29,11 @@ class UploadApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param SignedUrlCleanupInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param body:
+        :type body: SignedUrlCleanupInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -61,9 +56,11 @@ class UploadApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param SignedUrlCleanupInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param body:
+        :type body: SignedUrlCleanupInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['body',]  # noqa: E501
@@ -143,9 +140,11 @@ class UploadApi(object):
         Complete S3 uploads exceeding 5GB and create the final object in the bucket. Expected an upload id returned previously by the `POST /upload/signed-url` endpoint and the e-tags returned by S3 after uploaded each file part.
         This method makes a synchronous HTTP request by default.
 
-        :param CompleteS3MultipartUploadInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CompleteMultipartUploadOutput
+        :param body:
+        :type body: CompleteS3MultipartUploadInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CompleteMultipartUploadOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -169,9 +168,11 @@ class UploadApi(object):
         Complete S3 uploads exceeding 5GB and create the final object in the bucket. Expected an upload id returned previously by the `POST /upload/signed-url` endpoint and the e-tags returned by S3 after uploaded each file part.
         This method makes a synchronous HTTP request by default.
 
-        :param CompleteS3MultipartUploadInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CompleteMultipartUploadOutput
+        :param body:
+        :type body: CompleteS3MultipartUploadInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CompleteMultipartUploadOutput
         """
 
         all_params = ['body',]  # noqa: E501
@@ -251,9 +252,11 @@ class UploadApi(object):
         Return a signed upload URL for the requested storage provider_id. Multiple URLs are returned for S3 uploads exceeding 5GB.
         This method makes a synchronous HTTP request by default.
 
-        :param SignedUrlUploadInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SignedUrlUploadOutput
+        :param body:
+        :type body: SignedUrlUploadInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SignedUrlUploadOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -277,9 +280,11 @@ class UploadApi(object):
         Return a signed upload URL for the requested storage provider_id. Multiple URLs are returned for S3 uploads exceeding 5GB.
         This method makes a synchronous HTTP request by default.
 
-        :param SignedUrlUploadInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SignedUrlUploadOutput
+        :param body:
+        :type body: SignedUrlUploadInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SignedUrlUploadOutput
         """
 
         all_params = ['body',]  # noqa: E501
@@ -359,16 +364,25 @@ class UploadApi(object):
         ### Default behavior: > For technical reasons, no form field names can be repeated. Instead, use   (file1, file2) and so forth.  > A non-file form field called \"metadata\" is also required, which must be   a string containing JSON.  > See ``api/schemas/input/labelupload.json`` for the format of this metadata.  ### Signed URL upload with ``ticket`` > Upload a single file directly to the storage backend. The workflow is the following:    - Send a request with an empty ``?ticket=`` query parameter to get an upload ticket and URL   - Upload the file using a PUT request to the upload URL   - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload.   The file will be placed into the DB via this POST request.
         This method makes a synchronous HTTP request by default.
 
-        :param bool preserve_metadata:
-        :param str ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
-        :param str id:
-        :param ContainerType level:
-        :param str job:
-        :param str files:
-        :param object metadata: Metadata object
-        :param str content_type:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[File],UploadTicketOutput]
+        :param preserve_metadata:, defaults to false
+        :type preserve_metadata: bool, optional
+        :param ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
+        :type ticket: str, optional
+        :param id:
+        :type id: str, optional
+        :param level:
+        :type level: ContainerType, optional
+        :param job:
+        :type job: str, optional
+        :param files:
+        :type files: str, optional
+        :param metadata: Metadata object
+        :type metadata: object, optional
+        :param content_type:
+        :type content_type: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[File],UploadTicketOutput]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -392,16 +406,25 @@ class UploadApi(object):
         ### Default behavior: > For technical reasons, no form field names can be repeated. Instead, use   (file1, file2) and so forth.  > A non-file form field called \"metadata\" is also required, which must be   a string containing JSON.  > See ``api/schemas/input/labelupload.json`` for the format of this metadata.  ### Signed URL upload with ``ticket`` > Upload a single file directly to the storage backend. The workflow is the following:    - Send a request with an empty ``?ticket=`` query parameter to get an upload ticket and URL   - Upload the file using a PUT request to the upload URL   - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload.   The file will be placed into the DB via this POST request.
         This method makes a synchronous HTTP request by default.
 
-        :param bool preserve_metadata:
-        :param str ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
-        :param str id:
-        :param ContainerType level:
-        :param str job:
-        :param str files:
-        :param object metadata: Metadata object
-        :param str content_type:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[File],UploadTicketOutput]
+        :param preserve_metadata:, defaults to false
+        :type preserve_metadata: bool, optional
+        :param ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
+        :type ticket: str, optional
+        :param id:
+        :type id: str, optional
+        :param level:
+        :type level: ContainerType, optional
+        :param job:
+        :type job: str, optional
+        :param files:
+        :type files: str, optional
+        :param metadata: Metadata object
+        :type metadata: object, optional
+        :param content_type:
+        :type content_type: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[File],UploadTicketOutput]
         """
 
         all_params = ['preserve_metadata','ticket','id','level','job','files','metadata','content_type',]  # noqa: E501
@@ -484,17 +507,27 @@ class UploadApi(object):
         ### Default behavior:  > Upload data, allowing users to move sessions during scans without causing new data to be   created in referenced project/group.  ### Evaluation Order:  * If a matching acquisition UID is found anywhere on the system, the related files will be placed under that acquisition. * **OR** If a matching session UID is found, a new acquistion is created with the specified UID under that Session UID. * **OR** If a matching group ID and project label are found, a new session and acquisition will be created within that project * **OR** If a matching group ID is found, a new project and session and acquisition will be created within that group. * **OR** A new session and acquisition will be created within a special \"Unknown\" group and project, which is only visible to system administrators.  ### Signed URL upload with ``ticket`` > Upload a single file directly to the storage backend. The workflow is the following:    - Send a request with an empty ``?ticket=`` query parameter to get an upload ticket and URL   - Upload the file using a PUT request to the upload URL   - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload.   The file will be placed into the DB via this POST request.
         This method makes a synchronous HTTP request by default.
 
-        :param bool preserve_metadata:
-        :param str ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
-        :param bool uid_placement:
-        :param str id:
-        :param ContainerType level:
-        :param str job:
-        :param str files:
-        :param object metadata: Metadata object
-        :param str content_type:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[File],UploadTicketOutput]
+        :param preserve_metadata:, defaults to false
+        :type preserve_metadata: bool, optional
+        :param ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
+        :type ticket: str, optional
+        :param uid_placement:, defaults to true
+        :type uid_placement: bool, optional
+        :param id:
+        :type id: str, optional
+        :param level:
+        :type level: ContainerType, optional
+        :param job:
+        :type job: str, optional
+        :param files:
+        :type files: str, optional
+        :param metadata: Metadata object
+        :type metadata: object, optional
+        :param content_type:
+        :type content_type: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[File],UploadTicketOutput]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -518,17 +551,27 @@ class UploadApi(object):
         ### Default behavior:  > Upload data, allowing users to move sessions during scans without causing new data to be   created in referenced project/group.  ### Evaluation Order:  * If a matching acquisition UID is found anywhere on the system, the related files will be placed under that acquisition. * **OR** If a matching session UID is found, a new acquistion is created with the specified UID under that Session UID. * **OR** If a matching group ID and project label are found, a new session and acquisition will be created within that project * **OR** If a matching group ID is found, a new project and session and acquisition will be created within that group. * **OR** A new session and acquisition will be created within a special \"Unknown\" group and project, which is only visible to system administrators.  ### Signed URL upload with ``ticket`` > Upload a single file directly to the storage backend. The workflow is the following:    - Send a request with an empty ``?ticket=`` query parameter to get an upload ticket and URL   - Upload the file using a PUT request to the upload URL   - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload.   The file will be placed into the DB via this POST request.
         This method makes a synchronous HTTP request by default.
 
-        :param bool preserve_metadata:
-        :param str ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
-        :param bool uid_placement:
-        :param str id:
-        :param ContainerType level:
-        :param str job:
-        :param str files:
-        :param object metadata: Metadata object
-        :param str content_type:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[File],UploadTicketOutput]
+        :param preserve_metadata:, defaults to false
+        :type preserve_metadata: bool, optional
+        :param ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
+        :type ticket: str, optional
+        :param uid_placement:, defaults to true
+        :type uid_placement: bool, optional
+        :param id:
+        :type id: str, optional
+        :param level:
+        :type level: ContainerType, optional
+        :param job:
+        :type job: str, optional
+        :param files:
+        :type files: str, optional
+        :param metadata: Metadata object
+        :type metadata: object, optional
+        :param content_type:
+        :type content_type: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[File],UploadTicketOutput]
         """
 
         all_params = ['preserve_metadata','ticket','uid_placement','id','level','job','files','metadata','content_type',]  # noqa: E501
@@ -613,16 +656,25 @@ class UploadApi(object):
         ### Default behavior: > Same behavior as /api/upload/label,   except the metadata field must be uid format   See ``api/schemas/input/uidupload.json`` for the format of this metadata.  ### Signed URL upload with ``ticket`` > Upload a single file directly to the storage backend. The workflow is the following:    - Send a request with an empty ``?ticket=`` query parameter to get an upload ticket and URL   - Upload the file using a PUT request to the upload URL   - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload.   The file will be placed into the DB via this POST request.
         This method makes a synchronous HTTP request by default.
 
-        :param bool preserve_metadata:
-        :param str ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
-        :param str id:
-        :param ContainerType level:
-        :param str job:
-        :param str files:
-        :param object metadata: Metadata object
-        :param str content_type:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[File],UploadTicketOutput]
+        :param preserve_metadata:, defaults to false
+        :type preserve_metadata: bool, optional
+        :param ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
+        :type ticket: str, optional
+        :param id:
+        :type id: str, optional
+        :param level:
+        :type level: ContainerType, optional
+        :param job:
+        :type job: str, optional
+        :param files:
+        :type files: str, optional
+        :param metadata: Metadata object
+        :type metadata: object, optional
+        :param content_type:
+        :type content_type: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[File],UploadTicketOutput]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -646,16 +698,25 @@ class UploadApi(object):
         ### Default behavior: > Same behavior as /api/upload/label,   except the metadata field must be uid format   See ``api/schemas/input/uidupload.json`` for the format of this metadata.  ### Signed URL upload with ``ticket`` > Upload a single file directly to the storage backend. The workflow is the following:    - Send a request with an empty ``?ticket=`` query parameter to get an upload ticket and URL   - Upload the file using a PUT request to the upload URL   - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload.   The file will be placed into the DB via this POST request.
         This method makes a synchronous HTTP request by default.
 
-        :param bool preserve_metadata:
-        :param str ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
-        :param str id:
-        :param ContainerType level:
-        :param str job:
-        :param str files:
-        :param object metadata: Metadata object
-        :param str content_type:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[File],UploadTicketOutput]
+        :param preserve_metadata:, defaults to false
+        :type preserve_metadata: bool, optional
+        :param ticket: Use empty value to get a ticket, and provide the ticket id to finalize the upload
+        :type ticket: str, optional
+        :param id:
+        :type id: str, optional
+        :param level:
+        :type level: ContainerType, optional
+        :param job:
+        :type job: str, optional
+        :param files:
+        :type files: str, optional
+        :param metadata: Metadata object
+        :type metadata: object, optional
+        :param content_type:
+        :type content_type: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[File],UploadTicketOutput]
         """
 
         all_params = ['preserve_metadata','ticket','id','level','job','files','metadata','content_type',]  # noqa: E501
@@ -738,10 +799,13 @@ class UploadApi(object):
         The POST `/api/upload/signed-url` endpoint returns a url with a jwt token pointing to this endpoint if the storage provider is a local filesystem then the file can be uploaded simply by sending the file content in the body of the payload. The destination storage provider and the file path are encoded in the jwt token.
         This method makes a synchronous HTTP request by default.
 
-        :param str token: Upload token (required)
-        :param str body: Signed filesystem file upload payload (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SignedFSUploadOutput
+        :param token: Upload token
+        :type token: str
+        :param body: Signed filesystem file upload payload
+        :type body: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SignedFSUploadOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -765,10 +829,13 @@ class UploadApi(object):
         The POST `/api/upload/signed-url` endpoint returns a url with a jwt token pointing to this endpoint if the storage provider is a local filesystem then the file can be uploaded simply by sending the file content in the body of the payload. The destination storage provider and the file path are encoded in the jwt token.
         This method makes a synchronous HTTP request by default.
 
-        :param str token: Upload token (required)
-        :param str body: Signed filesystem file upload payload (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SignedFSUploadOutput
+        :param token: Upload token
+        :type token: str
+        :param body: Signed filesystem file upload payload
+        :type body: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SignedFSUploadOutput
         """
 
         all_params = ['token','body',]  # noqa: E501