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

snaptrade_client/paths/trade_trade_id/post.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,8 +32,13 @@ import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
 
-from snaptrade_client.model.model400_failed_request_response import Model400FailedRequestResponse
-from snaptrade_client.model.account_order_record import AccountOrderRecord
+from snaptrade_client.model.model400_failed_request_response import Model400FailedRequestResponse as Model400FailedRequestResponseSchema
+from snaptrade_client.model.account_order_record import AccountOrderRecord as AccountOrderRecordSchema
+from snaptrade_client.model.validated_trade_body import ValidatedTradeBody as ValidatedTradeBodySchema
+
+from snaptrade_client.type.validated_trade_body import ValidatedTradeBody
+from snaptrade_client.type.model400_failed_request_response import Model400FailedRequestResponse
+from snaptrade_client.type.account_order_record import AccountOrderRecord
 
 # Query params
 UserIdSchema = schemas.StrSchema
@@ -95,35 +102,53 @@ request_path_trade_id = api_client.PathParameter(
     schema=TradeIdSchema,
     required=True,
 )
-SchemaFor200ResponseBodyApplicationJson = AccountOrderRecord
+# body param
+SchemaForRequestBodyApplicationJson = ValidatedTradeBodySchema
+
+
+request_body_validated_trade_body = api_client.RequestBody(
+    content={
+        'application/json': api_client.MediaType(
+            schema=SchemaForRequestBodyApplicationJson),
+    },
+)
+SchemaFor200ResponseBodyApplicationJson = AccountOrderRecordSchema
 
 
 @dataclass
 class ApiResponseFor200(api_client.ApiResponse):
-    body: typing.Union[
-        SchemaFor200ResponseBodyApplicationJson,
-    ]
+    body: AccountOrderRecord
+
+
+@dataclass
+class ApiResponseFor200Async(api_client.AsyncApiResponse):
+    body: AccountOrderRecord
 
 
 _response_for_200 = api_client.OpenApiResponse(
     response_cls=ApiResponseFor200,
+    response_cls_async=ApiResponseFor200Async,
     content={
         'application/json': api_client.MediaType(
             schema=SchemaFor200ResponseBodyApplicationJson),
     },
 )
-SchemaFor400ResponseBodyApplicationJson = Model400FailedRequestResponse
+SchemaFor400ResponseBodyApplicationJson = Model400FailedRequestResponseSchema
 
 
 @dataclass
 class ApiResponseFor400(api_client.ApiResponse):
-    body: typing.Union[
-        SchemaFor400ResponseBodyApplicationJson,
-    ]
+    body: Model400FailedRequestResponse
+
+
+@dataclass
+class ApiResponseFor400Async(api_client.AsyncApiResponse):
+    body: Model400FailedRequestResponse
 
 
 _response_for_400 = api_client.OpenApiResponse(
     response_cls=ApiResponseFor400,
+    response_cls_async=ApiResponseFor400Async,
     content={
         'application/json': api_client.MediaType(
             schema=SchemaFor400ResponseBodyApplicationJson),
@@ -136,8 +161,14 @@ class ApiResponseFor500(api_client.ApiResponse):
     body: schemas.Unset = schemas.unset
 
 
+@dataclass
+class ApiResponseFor500Async(api_client.AsyncApiResponse):
+    body: schemas.Unset = schemas.unset
+
+
 _response_for_500 = api_client.OpenApiResponse(
     response_cls=ApiResponseFor500,
+    response_cls_async=ApiResponseFor500Async,
 )
 _all_accept_content_types = (
     'application/json',
@@ -146,19 +177,195 @@ _all_accept_content_types = (
 
 class BaseApi(api_client.Api):
 
+    def _place_order_mapped_args(
+        self,
+        body: typing.Optional[ValidatedTradeBody] = None,
+        trade_id: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        wait_to_confirm: typing.Optional[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 = {}
+        _body = {}
+        if wait_to_confirm is not None:
+            _body["wait_to_confirm"] = wait_to_confirm
+        args.body = body if body is not None else _body
+        if user_id is not None:
+            _query_params["userId"] = user_id
+        if user_secret is not None:
+            _query_params["userSecret"] = user_secret
+        if trade_id is not None:
+            _path_params["tradeId"] = trade_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 _aplace_order_oapg(
+        self,
+        body: typing.Any = None,
+        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,
+        content_type: str = 'application/json',
+        stream: bool = False,
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        """
+        Place checked equity order
+        :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_trade_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,
+        ):
+            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 = 'post'.upper()
+        _headers.add('Content-Type', content_type)
+    
+        _fields = None
+        _body = None
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/trade/{tradeId}',
+            body=body,
+            auth_settings=_auth,
+            headers=_headers,
+        )
+        if body is not schemas.unset:
+            serialized_data = request_body_validated_trade_body.serialize(body, content_type)
+            if 'fields' in serialized_data:
+                _fields = serialized_data['fields']
+            elif 'body' in serialized_data:
+                _body = serialized_data['body']
+    
+        response = await self.api_client.async_call_api(
+            resource_path=used_path,
+            method=method,
+            headers=_headers,
+            fields=_fields,
+            serialized_body=_body,
+            body=body,
+            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 _place_order_oapg(
         self,
+        body: typing.Any = None,
+        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] = {},
+        content_type: str = 'application/json',
+        stream: bool = False,
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Place order
+        Place checked equity order
         :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
@@ -166,7 +373,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_trade_id,
@@ -176,10 +383,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,
@@ -193,29 +400,52 @@ 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 = 'post'.upper()
+        _headers.add('Content-Type', content_type)
+    
+        _fields = None
+        _body = None
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/trade/{tradeId}',
+            body=body,
+            auth_settings=_auth,
+            headers=_headers,
+        )
+        if body is not schemas.unset:
+            serialized_data = request_body_validated_trade_body.serialize(body, content_type)
+            if 'fields' in serialized_data:
+                _fields = serialized_data['fields']
+            elif 'body' in serialized_data:
+                _body = serialized_data['body']
+    
         response = self.api_client.call_api(
             resource_path=used_path,
-            method='post'.upper(),
+            method=method,
             headers=_headers,
+            fields=_fields,
+            serialized_body=_body,
+            body=body,
             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', ''))
@@ -226,62 +456,136 @@ 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 PlaceOrder(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
+    async def aplace_order(
+        self,
+        body: typing.Optional[ValidatedTradeBody] = None,
+        trade_id: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        wait_to_confirm: typing.Optional[typing.Optional[bool]] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._place_order_mapped_args(
+            body=body,
+            query_params=query_params,
+            path_params=path_params,
+            trade_id=trade_id,
+            user_id=user_id,
+            user_secret=user_secret,
+            wait_to_confirm=wait_to_confirm,
+        )
+        return await self._aplace_order_oapg(
+            body=args.body,
+            query_params=args.query,
+            path_params=args.path,
+            **kwargs,
+        )
+    
     def place_order(
         self,
-        trade_id: typing.Any = None,
-        user_id: typing.Any = None,
-        user_secret: typing.Any = None,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
-        path_params: typing.Union[RequestPathParams, dict] = {},
+        body: typing.Optional[ValidatedTradeBody] = None,
+        trade_id: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        wait_to_confirm: typing.Optional[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 trade_id is not None:
-            path_params["tradeId"] = trade_id
-        return self._place_order_oapg(
+        """ Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.  """
+        args = self._place_order_mapped_args(
+            body=body,
             query_params=query_params,
             path_params=path_params,
+            trade_id=trade_id,
+            user_id=user_id,
+            user_secret=user_secret,
+            wait_to_confirm=wait_to_confirm,
+        )
+        return self._place_order_oapg(
+            body=args.body,
+            query_params=args.query,
+            path_params=args.path,
         )
-
 
 class ApiForpost(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
+    async def apost(
+        self,
+        body: typing.Optional[ValidatedTradeBody] = None,
+        trade_id: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        wait_to_confirm: typing.Optional[typing.Optional[bool]] = None,
+        query_params: typing.Optional[dict] = {},
+        path_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._place_order_mapped_args(
+            body=body,
+            query_params=query_params,
+            path_params=path_params,
+            trade_id=trade_id,
+            user_id=user_id,
+            user_secret=user_secret,
+            wait_to_confirm=wait_to_confirm,
+        )
+        return await self._aplace_order_oapg(
+            body=args.body,
+            query_params=args.query,
+            path_params=args.path,
+            **kwargs,
+        )
+    
     def post(
         self,
-        trade_id: typing.Any = None,
-        user_id: typing.Any = None,
-        user_secret: typing.Any = None,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
-        path_params: typing.Union[RequestPathParams, dict] = {},
+        body: typing.Optional[ValidatedTradeBody] = None,
+        trade_id: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        wait_to_confirm: typing.Optional[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 trade_id is not None:
-            path_params["tradeId"] = trade_id
-        return self._place_order_oapg(
+        """ Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.  """
+        args = self._place_order_mapped_args(
+            body=body,
             query_params=query_params,
             path_params=path_params,
+            trade_id=trade_id,
+            user_id=user_id,
+            user_secret=user_secret,
+            wait_to_confirm=wait_to_confirm,
+        )
+        return self._place_order_oapg(
+            body=args.body,
+            query_params=args.query,
+            path_params=args.path,
         )
-
 

snaptrade_client/request_before_hook.py

@@ -12,6 +12,7 @@ def request_before_hook(
         body: typing.Any = None,
         fields: typing.Optional[typing.Tuple[typing.Tuple[str, str], ...]] = None,
         auth_settings: typing.Optional[typing.List[str]] = None,
+        **kwargs: typing.Any
 ) -> str:
     if auth_settings is None:
         return

snaptrade_client/request_before_url_hook.py

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+import typing
+from urllib3._collections import HTTPHeaderDict
+from snaptrade_client.configuration import Configuration
+
+def request_before_url_hook(
+        resource_path_ref: typing.List[str],
+        method: str,
+        configuration: Configuration,
+        headers: typing.Optional[HTTPHeaderDict] = None,
+        body: typing.Any = None,
+        fields: typing.Optional[typing.Tuple[typing.Tuple[str, str], ...]] = None,
+        auth_settings: typing.Optional[typing.List[str]] = None,
+):
+    pass

snaptrade_client/rest.py

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 
@@ -15,6 +15,7 @@ import logging
 import ssl
 from urllib.parse import urlencode
 import typing
+import aiohttp
 
 import certifi
 import urllib3
@@ -27,10 +28,16 @@ from snaptrade_client.exceptions import ApiException, ApiValueError
 logger = logging.getLogger(__name__)
 
 class ResponseWrapper:
-    def __init__(self, http_response: urllib3.HTTPResponse, round_trip_time: int):
+    def __init__(self, http_response: urllib3.HTTPResponse, round_trip_time: float):
         self.http_response = http_response
         self.round_trip_time = round_trip_time
 
+class AsyncResponseWrapper:
+    def __init__(self, http_response: aiohttp.ClientResponse, round_trip_time: float, session: aiohttp.ClientSession):
+        self.http_response = http_response
+        self.round_trip_time = round_trip_time
+        self.session = session
+
 class RESTClientObject(object):
 
     def __init__(self, configuration, pools_size=4, maxsize=None):
@@ -101,7 +108,7 @@ class RESTClientObject(object):
         fields: typing.Optional[typing.Tuple[typing.Tuple[str, typing.Any], ...]] = None,
         body: typing.Optional[typing.Union[str, bytes]] = None,
         stream: bool = False,
-        timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
+        timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
     ) -> ResponseWrapper:
         """Perform requests.