wds-client 0.7.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

wds_client/api/import_api.py

@@ -3,162 +3,323 @@
 """
     Workspace Data Service
 
-    This page lists current APIs. As of v0.2, all APIs are subject to change without notice.   # noqa: E501
+    This page lists current APIs.  All v0.2 APIs are subject to change without notice.  Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/releases](https://github.com/DataBiosphere/terra-workspace-data-service/releases) 
 
     The version of the OpenAPI document: v0.2
-    Generated by: https://openapi-generator.tech
-"""
-
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-from __future__ import absolute_import
+    Do not edit the class manually.
+"""  # noqa: E501
 
-import re  # noqa: F401
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
 
-# python 2 and python 3 compatibility library
-import six
+from pydantic import Field, StrictStr
+from typing_extensions import Annotated
+from wds_client.models.generic_job import GenericJob
+from wds_client.models.import_request import ImportRequest
 
-from wds_client.api_client import ApiClient
-from wds_client.exceptions import (  # noqa: F401
-    ApiTypeError,
-    ApiValueError
-)
+from wds_client.api_client import ApiClient, RequestSerialized
+from wds_client.api_response import ApiResponse
+from wds_client.rest import RESTResponseType
 
 
-class ImportApi(object):
+class ImportApi:
     """NOTE: This class is auto generated by OpenAPI Generator
     Ref: https://openapi-generator.tech
 
     Do not edit the class manually.
     """
 
-    def __init__(self, api_client=None):
+    def __init__(self, api_client=None) -> None:
         if api_client is None:
-            api_client = ApiClient()
+            api_client = ApiClient.get_default()
         self.api_client = api_client
 
-    def import_v1(self, instance_uuid, import_request, **kwargs):  # noqa: E501
-        """Import from a file  # noqa: E501
-
-        Imports records from the specified URL.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.import_v1(instance_uuid, import_request, async_req=True)
-        >>> result = thread.get()
-
-        :param async_req bool: execute request asynchronously
-        :param str instance_uuid: WDS instance id; by convention equal to workspace id (required)
-        :param ImportRequest import_request: (required)
-        :param _preload_content: if False, the urllib3.HTTPResponse object will
-                                 be returned without reading/decoding response
-                                 data. Default is True.
+
+    @validate_call
+    def import_v1(
+        self,
+        instance_uuid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
+        import_request: Annotated[ImportRequest, Field(description="A request to import records from a file")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GenericJob:
+        """Import from a file
+
+        Imports records from the specified URL.
+
+        :param instance_uuid: WDS instance id; by convention equal to workspace id (required)
+        :type instance_uuid: str
+        :param import_request: A request to import records from a file (required)
+        :type import_request: ImportRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
-        :return: GenericJob
-                 If the method is called asynchronously,
-                 returns the request thread.
-        """
-        kwargs['_return_http_data_only'] = True
-        return self.import_v1_with_http_info(instance_uuid, import_request, **kwargs)  # noqa: E501
-
-    def import_v1_with_http_info(self, instance_uuid, import_request, **kwargs):  # noqa: E501
-        """Import from a file  # noqa: E501
-
-        Imports records from the specified URL.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.import_v1_with_http_info(instance_uuid, import_request, async_req=True)
-        >>> result = thread.get()
-
-        :param async_req bool: execute request asynchronously
-        :param str instance_uuid: WDS instance id; by convention equal to workspace id (required)
-        :param ImportRequest import_request: (required)
-        :param _return_http_data_only: response data without head status code
-                                       and headers
-        :param _preload_content: if False, the urllib3.HTTPResponse object will
-                                 be returned without reading/decoding response
-                                 data. Default is True.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._import_v1_serialize(
+            instance_uuid=instance_uuid,
+            import_request=import_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '202': "GenericJob",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def import_v1_with_http_info(
+        self,
+        instance_uuid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
+        import_request: Annotated[ImportRequest, Field(description="A request to import records from a file")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GenericJob]:
+        """Import from a file
+
+        Imports records from the specified URL.
+
+        :param instance_uuid: WDS instance id; by convention equal to workspace id (required)
+        :type instance_uuid: str
+        :param import_request: A request to import records from a file (required)
+        :type import_request: ImportRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
-        :return: tuple(GenericJob, status_code(int), headers(HTTPHeaderDict))
-                 If the method is called asynchronously,
-                 returns the request thread.
-        """
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
 
-        local_var_params = locals()
+        _param = self._import_v1_serialize(
+            instance_uuid=instance_uuid,
+            import_request=import_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
 
-        all_params = [
-            'instance_uuid',
-            'import_request'
-        ]
-        all_params.extend(
+        _response_types_map: Dict[str, Optional[str]] = {
+            '202': "GenericJob",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def import_v1_without_preload_content(
+        self,
+        instance_uuid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
+        import_request: Annotated[ImportRequest, Field(description="A request to import records from a file")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Import from a file
+
+        Imports records from the specified URL.
+
+        :param instance_uuid: WDS instance id; by convention equal to workspace id (required)
+        :type instance_uuid: str
+        :param import_request: A request to import records from a file (required)
+        :type import_request: ImportRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._import_v1_serialize(
+            instance_uuid=instance_uuid,
+            import_request=import_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '202': "GenericJob",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _import_v1_serialize(
+        self,
+        instance_uuid,
+        import_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if instance_uuid is not None:
+            _path_params['instanceUuid'] = instance_uuid
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if import_request is not None:
+            _body_params = import_request
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
             [
-                'async_req',
-                '_return_http_data_only',
-                '_preload_content',
-                '_request_timeout'
+                'application/json'
             ]
         )
 
-        for key, val in six.iteritems(local_var_params['kwargs']):
-            if key not in all_params:
-                raise ApiTypeError(
-                    "Got an unexpected keyword argument '%s'"
-                    " to method import_v1" % key
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
                 )
-            local_var_params[key] = val
-        del local_var_params['kwargs']
-        # verify the required parameter 'instance_uuid' is set
-        if self.api_client.client_side_validation and ('instance_uuid' not in local_var_params or  # noqa: E501
-                                                        local_var_params['instance_uuid'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `instance_uuid` when calling `import_v1`")  # noqa: E501
-        # verify the required parameter 'import_request' is set
-        if self.api_client.client_side_validation and ('import_request' not in local_var_params or  # noqa: E501
-                                                        local_var_params['import_request'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `import_request` when calling `import_v1`")  # noqa: E501
-
-        collection_formats = {}
-
-        path_params = {}
-        if 'instance_uuid' in local_var_params:
-            path_params['instanceUuid'] = local_var_params['instance_uuid']  # noqa: E501
-
-        query_params = []
-
-        header_params = {}
-
-        form_params = []
-        local_var_files = {}
-
-        body_params = None
-        if 'import_request' in local_var_params:
-            body_params = local_var_params['import_request']
-        # HTTP header `Accept`
-        header_params['Accept'] = self.api_client.select_header_accept(
-            ['application/json'])  # noqa: E501
-
-        # HTTP header `Content-Type`
-        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
-            ['application/json'])  # noqa: E501
-
-        # Authentication setting
-        auth_settings = ['bearerAuth']  # noqa: E501
-
-        return self.api_client.call_api(
-            '/{instanceUuid}/import/v1', 'POST',
-            path_params,
-            query_params,
-            header_params,
-            body=body_params,
-            post_params=form_params,
-            files=local_var_files,
-            response_type='GenericJob',  # noqa: E501
-            auth_settings=auth_settings,
-            async_req=local_var_params.get('async_req'),
-            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
-            _preload_content=local_var_params.get('_preload_content', True),
-            _request_timeout=local_var_params.get('_request_timeout'),
-            collection_formats=collection_formats)
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/{instanceUuid}/import/v1',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+