snaptrade-python-sdk 10.9.0__py3-none-any.whl → 11.0.152__py3-none-any.whl

snaptrade_client/paths/accounts_account_id_quotes/get.pyi

@@ -7,15 +7,17 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from dataclasses import dataclass
 import typing_extensions
 import urllib3
+from snaptrade_client.request_before_hook import request_before_hook
 import json
 from urllib3._collections import HTTPHeaderDict
 
+from snaptrade_client.api_response import AsyncGeneratorResponse
 from snaptrade_client import api_client, exceptions
 from datetime import date, datetime  # noqa: F401
 import decimal  # noqa: F401
@@ -30,7 +32,11 @@ import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
 
-from snaptrade_client.model.symbols_quotes import SymbolsQuotes
+from snaptrade_client.model.symbols_quotes import SymbolsQuotes as SymbolsQuotesSchema
+from snaptrade_client.model.model500_unexpected_exception_response import Model500UnexpectedExceptionResponse as Model500UnexpectedExceptionResponseSchema
+
+from snaptrade_client.type.symbols_quotes import SymbolsQuotes
+from snaptrade_client.type.model500_unexpected_exception_response import Model500UnexpectedExceptionResponse
 
 # Query params
 UserIdSchema = schemas.StrSchema
@@ -111,32 +117,47 @@ request_path_account_id = api_client.PathParameter(
     schema=AccountIdSchema,
     required=True,
 )
-SchemaFor200ResponseBodyApplicationJson = SymbolsQuotes
+SchemaFor200ResponseBodyApplicationJson = SymbolsQuotesSchema
 
 
 @dataclass
 class ApiResponseFor200(api_client.ApiResponse):
-    body: typing.Union[
-        SchemaFor200ResponseBodyApplicationJson,
-    ]
+    body: SymbolsQuotes
+
+
+@dataclass
+class ApiResponseFor200Async(api_client.AsyncApiResponse):
+    body: SymbolsQuotes
 
 
 _response_for_200 = api_client.OpenApiResponse(
     response_cls=ApiResponseFor200,
+    response_cls_async=ApiResponseFor200Async,
     content={
         'application/json': api_client.MediaType(
             schema=SchemaFor200ResponseBodyApplicationJson),
     },
 )
+SchemaFor500ResponseBodyApplicationJson = Model500UnexpectedExceptionResponseSchema
 
 
 @dataclass
 class ApiResponseFor500(api_client.ApiResponse):
-    body: schemas.Unset = schemas.unset
+    body: Model500UnexpectedExceptionResponse
+
+
+@dataclass
+class ApiResponseFor500Async(api_client.AsyncApiResponse):
+    body: Model500UnexpectedExceptionResponse
 
 
 _response_for_500 = api_client.OpenApiResponse(
     response_cls=ApiResponseFor500,
+    response_cls_async=ApiResponseFor500Async,
+    content={
+        'application/json': api_client.MediaType(
+            schema=SchemaFor500ResponseBodyApplicationJson),
+    },
 )
 _all_accept_content_types = (
     'application/json',
@@ -145,19 +166,179 @@ _all_accept_content_types = (
 
 class BaseApi(api_client.Api):
 
+    def _get_user_account_quotes_mapped_args(
+        self,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        symbols: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
+        use_ticker: typing.Optional[bool] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
+    ) -> api_client.MappedArgs:
+        args: api_client.MappedArgs = api_client.MappedArgs()
+        _query_params = {}
+        _path_params = {}
+        if user_id is not None:
+            _query_params["userId"] = user_id
+        if user_secret is not None:
+            _query_params["userSecret"] = user_secret
+        if symbols is not None:
+            _query_params["symbols"] = symbols
+        if use_ticker is not None:
+            _query_params["use_ticker"] = use_ticker
+        if account_id is not None:
+            _path_params["accountId"] = account_id
+        args.query = query_params if query_params else _query_params
+        args.path = path_params if path_params else _path_params
+        return args
+
+    async def _aget_user_account_quotes_oapg(
+        self,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
+        skip_deserialization: bool = True,
+        timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
+        accept_content_types: typing.Tuple[str] = _all_accept_content_types,
+        stream: bool = False,
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        """
+        Get equity symbol quotes
+        :param skip_deserialization: If true then api_response.response will be set but
+            api_response.body and api_response.headers will not be deserialized into schema
+            class instances
+        """
+        self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params)
+        self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params)
+        used_path = path.value
+    
+        _path_params = {}
+        for parameter in (
+            request_path_account_id,
+        ):
+            parameter_data = path_params.get(parameter.name, schemas.unset)
+            if parameter_data is schemas.unset:
+                continue
+            serialized_data = parameter.serialize(parameter_data)
+            _path_params.update(serialized_data)
+    
+        for k, v in _path_params.items():
+            used_path = used_path.replace('{%s}' % k, v)
+    
+        prefix_separator_iterator = None
+        for parameter in (
+            request_query_user_id,
+            request_query_user_secret,
+            request_query_symbols,
+            request_query_use_ticker,
+        ):
+            parameter_data = query_params.get(parameter.name, schemas.unset)
+            if parameter_data is schemas.unset:
+                continue
+            if prefix_separator_iterator is None:
+                prefix_separator_iterator = parameter.get_prefix_separator_iterator()
+            serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator)
+            for serialized_value in serialized_data.values():
+                used_path += serialized_value
+    
+        _headers = HTTPHeaderDict()
+        # TODO add cookie handling
+        if accept_content_types:
+            for accept_content_type in accept_content_types:
+                _headers.add('Accept', accept_content_type)
+        method = 'get'.upper()
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/accounts/{accountId}/quotes',
+            auth_settings=_auth,
+            headers=_headers,
+        )
+    
+        response = await self.api_client.async_call_api(
+            resource_path=used_path,
+            method=method,
+            headers=_headers,
+            auth_settings=_auth,
+            prefix_separator_iterator=prefix_separator_iterator,
+            timeout=timeout,
+            **kwargs
+        )
+    
+        if stream:
+            if not 200 <= response.http_response.status <= 299:
+                body = (await response.http_response.content.read()).decode("utf-8")
+                raise exceptions.ApiStreamingException(
+                    status=response.http_response.status,
+                    reason=response.http_response.reason,
+                    body=body,
+                )
+    
+            async def stream_iterator():
+                """
+                iterates over response.http_response.content and closes connection once iteration has finished
+                """
+                async for line in response.http_response.content:
+                    if line == b'\r\n':
+                        continue
+                    yield line
+                response.http_response.close()
+                await response.session.close()
+            return AsyncGeneratorResponse(
+                content=stream_iterator(),
+                headers=response.http_response.headers,
+                status=response.http_response.status,
+                response=response.http_response
+            )
+    
+        response_for_status = _status_code_to_response.get(str(response.http_response.status))
+        if response_for_status:
+            api_response = await response_for_status.deserialize_async(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+        else:
+            # If response data is JSON then deserialize for SDK consumer convenience
+            is_json = api_client.JSONDetector._content_type_is_json(response.http_response.headers.get('Content-Type', ''))
+            api_response = api_client.ApiResponseWithoutDeserializationAsync(
+                body=await response.http_response.json() if is_json else await response.http_response.text(),
+                response=response.http_response,
+                round_trip_time=response.round_trip_time,
+                status=response.http_response.status,
+                headers=response.http_response.headers,
+            )
+    
+        if not 200 <= api_response.status <= 299:
+            raise exceptions.ApiException(api_response=api_response)
+    
+        # cleanup session / response
+        response.http_response.close()
+        await response.session.close()
+    
+        return api_response
+
+
     def _get_user_account_quotes_oapg(
         self,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
         skip_deserialization: bool = True,
-        timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
+        timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
-        path_params: typing.Union[RequestPathParams, dict] = {},
+        stream: bool = False,
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Get symbol quotes
+        Get equity symbol quotes
         :param skip_deserialization: If true then api_response.response will be set but
             api_response.body and api_response.headers will not be deserialized into schema
             class instances
@@ -165,7 +346,7 @@ class BaseApi(api_client.Api):
         self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params)
         self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params)
         used_path = path.value
-
+    
         _path_params = {}
         for parameter in (
             request_path_account_id,
@@ -175,10 +356,10 @@ class BaseApi(api_client.Api):
                 continue
             serialized_data = parameter.serialize(parameter_data)
             _path_params.update(serialized_data)
-
+    
         for k, v in _path_params.items():
             used_path = used_path.replace('{%s}' % k, v)
-
+    
         prefix_separator_iterator = None
         for parameter in (
             request_query_user_id,
@@ -194,29 +375,38 @@ class BaseApi(api_client.Api):
             serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator)
             for serialized_value in serialized_data.values():
                 used_path += serialized_value
-
+    
         _headers = HTTPHeaderDict()
         # TODO add cookie handling
         if accept_content_types:
             for accept_content_type in accept_content_types:
                 _headers.add('Accept', accept_content_type)
-
+        method = 'get'.upper()
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/accounts/{accountId}/quotes',
+            auth_settings=_auth,
+            headers=_headers,
+        )
+    
         response = self.api_client.call_api(
             resource_path=used_path,
-            method='get'.upper(),
+            method=method,
             headers=_headers,
             auth_settings=_auth,
             prefix_separator_iterator=prefix_separator_iterator,
             timeout=timeout,
         )
-
+    
         response_for_status = _status_code_to_response.get(str(response.http_response.status))
         if response_for_status:
             api_response = response_for_status.deserialize(
-                                                   response,
-                                                   self.api_client.configuration,
-                                                   skip_deserialization=skip_deserialization
-                                               )
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
         else:
             # If response data is JSON then deserialize for SDK consumer convenience
             is_json = api_client.JSONDetector._content_type_is_json(response.http_response.headers.get('Content-Type', ''))
@@ -227,74 +417,132 @@ class BaseApi(api_client.Api):
                 status=response.http_response.status,
                 headers=response.http_response.headers,
             )
-
+    
         if not 200 <= api_response.status <= 299:
             raise exceptions.ApiException(api_response=api_response)
-
+    
         return api_response
 
 
 class GetUserAccountQuotes(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
+    async def aget_user_account_quotes(
+        self,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        symbols: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
+        use_ticker: typing.Optional[bool] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._get_user_account_quotes_mapped_args(
+            query_params=query_params,
+            path_params=path_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            symbols=symbols,
+            account_id=account_id,
+            use_ticker=use_ticker,
+        )
+        return await self._aget_user_account_quotes_oapg(
+            query_params=args.query,
+            path_params=args.path,
+            **kwargs,
+        )
+    
     def get_user_account_quotes(
         self,
-        user_id: typing.Any = None,
-        user_secret: typing.Any = None,
-        symbols: typing.Any = None,
-        account_id: typing.Any = None,
-        use_ticker: typing.Any = None,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
-        path_params: typing.Union[RequestPathParams, dict] = {},
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        symbols: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
+        use_ticker: typing.Optional[bool] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        if user_id is not None:
-            query_params["userId"] = user_id
-        if user_secret is not None:
-            query_params["userSecret"] = user_secret
-        if symbols is not None:
-            query_params["symbols"] = symbols
-        if use_ticker is not None:
-            query_params["use_ticker"] = use_ticker
-        if account_id is not None:
-            path_params["accountId"] = account_id
-        return self._get_user_account_quotes_oapg(
+        """ Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.  """
+        args = self._get_user_account_quotes_mapped_args(
             query_params=query_params,
             path_params=path_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            symbols=symbols,
+            account_id=account_id,
+            use_ticker=use_ticker,
+        )
+        return self._get_user_account_quotes_oapg(
+            query_params=args.query,
+            path_params=args.path,
         )
-
 
 class ApiForget(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
+    async def aget(
+        self,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        symbols: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
+        use_ticker: typing.Optional[bool] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._get_user_account_quotes_mapped_args(
+            query_params=query_params,
+            path_params=path_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            symbols=symbols,
+            account_id=account_id,
+            use_ticker=use_ticker,
+        )
+        return await self._aget_user_account_quotes_oapg(
+            query_params=args.query,
+            path_params=args.path,
+            **kwargs,
+        )
+    
     def get(
         self,
-        user_id: typing.Any = None,
-        user_secret: typing.Any = None,
-        symbols: typing.Any = None,
-        account_id: typing.Any = None,
-        use_ticker: typing.Any = None,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
-        path_params: typing.Union[RequestPathParams, dict] = {},
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        symbols: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
+        use_ticker: typing.Optional[bool] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        if user_id is not None:
-            query_params["userId"] = user_id
-        if user_secret is not None:
-            query_params["userSecret"] = user_secret
-        if symbols is not None:
-            query_params["symbols"] = symbols
-        if use_ticker is not None:
-            query_params["use_ticker"] = use_ticker
-        if account_id is not None:
-            path_params["accountId"] = account_id
-        return self._get_user_account_quotes_oapg(
+        """ Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.  """
+        args = self._get_user_account_quotes_mapped_args(
             query_params=query_params,
             path_params=path_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            symbols=symbols,
+            account_id=account_id,
+            use_ticker=use_ticker,
+        )
+        return self._get_user_account_quotes_oapg(
+            query_params=args.query,
+            path_params=args.path,
         )
-
 

snaptrade_client/paths/accounts_account_id_recent_orders/__init__.py

@@ -0,0 +1,7 @@
+# do not import all endpoints into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all endpoints from this module, import them with
+# from snaptrade_client.paths.accounts_account_id_recent_orders import Api
+
+from snaptrade_client.paths import PathValues
+
+path = PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS