snaptrade-python-sdk 11.0.121__tar.gz → 11.0.122__tar.gz

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 11.0.121
+Version: 11.0.122
 Summary: Client for SnapTrade
 License: MIT
 Author: SnapTrade
@@ -30,7 +30,7 @@ Description-Content-Type: text/markdown
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.121-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.121)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.122-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.122)
 [![README.md](https://img.shields.io/badge/README-Click%20Here-green)](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/python#readme)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
@@ -111,7 +111,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.121
+pip install snaptrade-python-sdk==11.0.122
 ```
 
 ## Getting Started<a id="getting-started"></a>

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/README.md

@@ -7,7 +7,7 @@
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.121-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.121)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.122-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.122)
 [![README.md](https://img.shields.io/badge/README-Click%20Here-green)](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/python#readme)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
@@ -88,7 +88,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.121
+pip install snaptrade-python-sdk==11.0.122
 ```
 
 ## Getting Started<a id="getting-started"></a>

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snaptrade-python-sdk"
-version = "11.0.121"
+version = "11.0.122"
 description = "Client for SnapTrade"
 authors = ["SnapTrade <api@snaptrade.com>"]
 license = "MIT"

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/__init__.py

@@ -12,7 +12,7 @@
     Created by: https://snaptrade.com/
 """
 
-__version__ = "11.0.121"
+__version__ = "11.0.122"
 
 # import ApiClient
 from snaptrade_client.api_client import ApiClient

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/api_client.py

@@ -1155,7 +1155,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Konfig/11.0.121/python'
+        self.user_agent = 'Konfig/11.0.122/python'
 
     def __enter__(self):
         return self

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/configuration.py

@@ -438,7 +438,7 @@ conf = snaptrade_client.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 11.0.121".\
+               "SDK Package Version: 11.0.122".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/model/position.py

@@ -141,6 +141,42 @@ class Position(
                         *args,
                         _configuration=_configuration,
                     )
+            
+            
+            class currency(
+                schemas.ComposedSchema,
+            ):
+            
+            
+                class MetaOapg:
+                    
+                    @classmethod
+                    @functools.lru_cache()
+                    def all_of(cls):
+                        # we need this here to make our import statements work
+                        # we must store _composed_schemas in here so the code is only run
+                        # when we invoke this method. If we kept this at the class
+                        # level we would get an error because the class level
+                        # code would be run when this module is imported, and these composed
+                        # classes don't exist yet because their module has not finished
+                        # loading
+                        return [
+                            Currency,
+                        ]
+            
+            
+                def __new__(
+                    cls,
+                    *args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
+                    _configuration: typing.Optional[schemas.Configuration] = None,
+                    **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
+                ) -> 'currency':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                        **kwargs,
+                    )
             __annotations__ = {
                 "symbol": symbol,
                 "units": units,
@@ -148,6 +184,7 @@ class Position(
                 "open_pnl": open_pnl,
                 "average_purchase_price": average_purchase_price,
                 "fractional_units": fractional_units,
+                "currency": currency,
             }
         additional_properties = schemas.AnyTypeSchema
     
@@ -169,10 +206,13 @@ class Position(
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["fractional_units"]) -> MetaOapg.properties.fractional_units: ...
     
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["currency"]) -> MetaOapg.properties.currency: ...
+    
     @typing.overload
     def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
     
-    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], str, ]):
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], typing_extensions.Literal["currency"], str, ]):
         # dict_instance[name] accessor
         return super().__getitem__(name)
     
@@ -194,10 +234,13 @@ class Position(
     @typing.overload
     def get_item_oapg(self, name: typing_extensions.Literal["fractional_units"]) -> typing.Union[MetaOapg.properties.fractional_units, schemas.Unset]: ...
     
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["currency"]) -> typing.Union[MetaOapg.properties.currency, schemas.Unset]: ...
+    
     @typing.overload
     def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ...
     
-    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], str, ]):
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], typing_extensions.Literal["currency"], str, ]):
         return super().get_item_oapg(name)
 
     def __new__(
@@ -209,6 +252,7 @@ class Position(
         open_pnl: typing.Union[MetaOapg.properties.open_pnl, None, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
         average_purchase_price: typing.Union[MetaOapg.properties.average_purchase_price, None, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
         fractional_units: typing.Union[MetaOapg.properties.fractional_units, None, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
+        currency: typing.Union[MetaOapg.properties.currency, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset,
         _configuration: typing.Optional[schemas.Configuration] = None,
         **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
     ) -> 'Position':
@@ -221,8 +265,10 @@ class Position(
             open_pnl=open_pnl,
             average_purchase_price=average_purchase_price,
             fractional_units=fractional_units,
+            currency=currency,
             _configuration=_configuration,
             **kwargs,
         )
 
+from snaptrade_client.model.currency import Currency
 from snaptrade_client.model.position_symbol import PositionSymbol

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/model/position.pyi

@@ -141,6 +141,42 @@ class Position(
                         *args,
                         _configuration=_configuration,
                     )
+            
+            
+            class currency(
+                schemas.ComposedSchema,
+            ):
+            
+            
+                class MetaOapg:
+                    
+                    @classmethod
+                    @functools.lru_cache()
+                    def all_of(cls):
+                        # we need this here to make our import statements work
+                        # we must store _composed_schemas in here so the code is only run
+                        # when we invoke this method. If we kept this at the class
+                        # level we would get an error because the class level
+                        # code would be run when this module is imported, and these composed
+                        # classes don't exist yet because their module has not finished
+                        # loading
+                        return [
+                            Currency,
+                        ]
+            
+            
+                def __new__(
+                    cls,
+                    *args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
+                    _configuration: typing.Optional[schemas.Configuration] = None,
+                    **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
+                ) -> 'currency':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                        **kwargs,
+                    )
             __annotations__ = {
                 "symbol": symbol,
                 "units": units,
@@ -148,6 +184,7 @@ class Position(
                 "open_pnl": open_pnl,
                 "average_purchase_price": average_purchase_price,
                 "fractional_units": fractional_units,
+                "currency": currency,
             }
         additional_properties = schemas.AnyTypeSchema
     
@@ -169,10 +206,13 @@ class Position(
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["fractional_units"]) -> MetaOapg.properties.fractional_units: ...
     
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["currency"]) -> MetaOapg.properties.currency: ...
+    
     @typing.overload
     def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
     
-    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], str, ]):
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], typing_extensions.Literal["currency"], str, ]):
         # dict_instance[name] accessor
         return super().__getitem__(name)
     
@@ -194,10 +234,13 @@ class Position(
     @typing.overload
     def get_item_oapg(self, name: typing_extensions.Literal["fractional_units"]) -> typing.Union[MetaOapg.properties.fractional_units, schemas.Unset]: ...
     
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["currency"]) -> typing.Union[MetaOapg.properties.currency, schemas.Unset]: ...
+    
     @typing.overload
     def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ...
     
-    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], str, ]):
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["units"], typing_extensions.Literal["price"], typing_extensions.Literal["open_pnl"], typing_extensions.Literal["average_purchase_price"], typing_extensions.Literal["fractional_units"], typing_extensions.Literal["currency"], str, ]):
         return super().get_item_oapg(name)
 
     def __new__(
@@ -209,6 +252,7 @@ class Position(
         open_pnl: typing.Union[MetaOapg.properties.open_pnl, None, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
         average_purchase_price: typing.Union[MetaOapg.properties.average_purchase_price, None, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
         fractional_units: typing.Union[MetaOapg.properties.fractional_units, None, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
+        currency: typing.Union[MetaOapg.properties.currency, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset,
         _configuration: typing.Optional[schemas.Configuration] = None,
         **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
     ) -> 'Position':
@@ -221,8 +265,10 @@ class Position(
             open_pnl=open_pnl,
             average_purchase_price=average_purchase_price,
             fractional_units=fractional_units,
+            currency=currency,
             _configuration=_configuration,
             **kwargs,
         )
 
+from snaptrade_client.model.currency import Currency
 from snaptrade_client.model.position_symbol import PositionSymbol

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/paths/trade_place/post.py

@@ -262,7 +262,7 @@ class BaseApi(api_client.Api):
         AsyncGeneratorResponse,
     ]:
         """
-        Place equity order
+        Place 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
@@ -393,7 +393,7 @@ class BaseApi(api_client.Api):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Place equity order
+        Place 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

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/paths/trade_place/post.pyi

@@ -249,7 +249,7 @@ class BaseApi(api_client.Api):
         AsyncGeneratorResponse,
     ]:
         """
-        Place equity order
+        Place 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
@@ -380,7 +380,7 @@ class BaseApi(api_client.Api):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Place equity order
+        Place 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

{snaptrade_python_sdk-11.0.121 → snaptrade_python_sdk-11.0.122}/snaptrade_client/type/position.py

@@ -15,6 +15,7 @@ import typing
 from enum import Enum
 from typing_extensions import TypedDict, Literal, TYPE_CHECKING
 
+from snaptrade_client.type.currency import Currency
 from snaptrade_client.type.position_symbol import PositionSymbol
 
 class RequiredPosition(TypedDict):
@@ -39,5 +40,8 @@ class OptionalPosition(TypedDict, total=False):
     # Deprecated, use the `units` field for both fractional and integer units going forward
     fractional_units: typing.Optional[typing.Union[int, float]]
 
+    # The 'position currency' (`price` and `average_purchase_price`). This currency can potentially be different from the 'listing currency' of the security. The 'listing currency' is what's quoted on the listing exchange, while the 'position currency' is what the brokerage uses to hold and value your position. 
+    currency: Currency
+
 class Position(RequiredPosition, OptionalPosition):
     pass