snaptrade-python-sdk 12.0.2__tar.gz → 12.0.3__tar.gz

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 12.0.2
+Version: 12.0.3
 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-v12.0.2-blue)](https://pypi.org/project/snaptrade-python-sdk/12.0.2)
+[![PyPI](https://img.shields.io/badge/PyPI-v12.0.3-blue)](https://pypi.org/project/snaptrade-python-sdk/12.0.3)
 [![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/)
 
@@ -122,7 +122,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==12.0.2
+pip install snaptrade-python-sdk==12.0.3
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -344,7 +344,7 @@ Returns a list of all positions in the specified account.
 
 The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
 
-`mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
+`mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account.
 
 If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
 

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/README.md

@@ -7,7 +7,7 @@
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v12.0.2-blue)](https://pypi.org/project/snaptrade-python-sdk/12.0.2)
+[![PyPI](https://img.shields.io/badge/PyPI-v12.0.3-blue)](https://pypi.org/project/snaptrade-python-sdk/12.0.3)
 [![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/)
 
@@ -99,7 +99,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==12.0.2
+pip install snaptrade-python-sdk==12.0.3
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -321,7 +321,7 @@ Returns a list of all positions in the specified account.
 
 The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
 
-`mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
+`mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account.
 
 If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
 

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/pyproject.toml

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

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/__init__.py

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

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/api_client.py

@@ -1159,7 +1159,7 @@ class ApiClient(typing.Generic[TAuth]):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Konfig/12.0.2/python'
+        self.user_agent = 'Konfig/12.0.3/python'
 
     def __enter__(self):
         return self

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/configuration.py

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

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/model/holdings_status.py

@@ -46,9 +46,11 @@ class HoldingsStatus(
             @staticmethod
             def last_successful_sync() -> typing.Type['HoldingsSyncStatusDateNullable']:
                 return HoldingsSyncStatusDateNullable
+            holdings_unavailable = schemas.BoolSchema
             __annotations__ = {
                 "initial_sync_completed": initial_sync_completed,
                 "last_successful_sync": last_successful_sync,
+                "holdings_unavailable": holdings_unavailable,
             }
 
     
@@ -58,10 +60,13 @@ class HoldingsStatus(
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["last_successful_sync"]) -> 'HoldingsSyncStatusDateNullable': ...
     
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["holdings_unavailable"]) -> MetaOapg.properties.holdings_unavailable: ...
+    
     @typing.overload
     def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
     
-    def __getitem__(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", ], str]):
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", "holdings_unavailable", ], str]):
         # dict_instance[name] accessor
         return super().__getitem__(name)
     
@@ -72,10 +77,13 @@ class HoldingsStatus(
     @typing.overload
     def get_item_oapg(self, name: typing_extensions.Literal["last_successful_sync"]) -> typing.Union['HoldingsSyncStatusDateNullable', schemas.Unset]: ...
     
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["holdings_unavailable"]) -> typing.Union[MetaOapg.properties.holdings_unavailable, schemas.Unset]: ...
+    
     @typing.overload
     def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
     
-    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", ], str]):
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", "holdings_unavailable", ], str]):
         return super().get_item_oapg(name)
     
 
@@ -84,6 +92,7 @@ class HoldingsStatus(
         *args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
         initial_sync_completed: typing.Union[MetaOapg.properties.initial_sync_completed, bool, schemas.Unset] = schemas.unset,
         last_successful_sync: typing.Union['HoldingsSyncStatusDateNullable', schemas.Unset] = schemas.unset,
+        holdings_unavailable: typing.Union[MetaOapg.properties.holdings_unavailable, bool, schemas.Unset] = schemas.unset,
         _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],
     ) -> 'HoldingsStatus':
@@ -92,6 +101,7 @@ class HoldingsStatus(
             *args,
             initial_sync_completed=initial_sync_completed,
             last_successful_sync=last_successful_sync,
+            holdings_unavailable=holdings_unavailable,
             _configuration=_configuration,
             **kwargs,
         )

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/model/holdings_status.pyi

@@ -46,9 +46,11 @@ class HoldingsStatus(
             @staticmethod
             def last_successful_sync() -> typing.Type['HoldingsSyncStatusDateNullable']:
                 return HoldingsSyncStatusDateNullable
+            holdings_unavailable = schemas.BoolSchema
             __annotations__ = {
                 "initial_sync_completed": initial_sync_completed,
                 "last_successful_sync": last_successful_sync,
+                "holdings_unavailable": holdings_unavailable,
             }
 
     
@@ -58,10 +60,13 @@ class HoldingsStatus(
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["last_successful_sync"]) -> 'HoldingsSyncStatusDateNullable': ...
     
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["holdings_unavailable"]) -> MetaOapg.properties.holdings_unavailable: ...
+    
     @typing.overload
     def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
     
-    def __getitem__(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", ], str]):
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", "holdings_unavailable", ], str]):
         # dict_instance[name] accessor
         return super().__getitem__(name)
     
@@ -72,10 +77,13 @@ class HoldingsStatus(
     @typing.overload
     def get_item_oapg(self, name: typing_extensions.Literal["last_successful_sync"]) -> typing.Union['HoldingsSyncStatusDateNullable', schemas.Unset]: ...
     
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["holdings_unavailable"]) -> typing.Union[MetaOapg.properties.holdings_unavailable, schemas.Unset]: ...
+    
     @typing.overload
     def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
     
-    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", ], str]):
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["initial_sync_completed", "last_successful_sync", "holdings_unavailable", ], str]):
         return super().get_item_oapg(name)
     
 
@@ -84,6 +92,7 @@ class HoldingsStatus(
         *args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
         initial_sync_completed: typing.Union[MetaOapg.properties.initial_sync_completed, bool, schemas.Unset] = schemas.unset,
         last_successful_sync: typing.Union['HoldingsSyncStatusDateNullable', schemas.Unset] = schemas.unset,
+        holdings_unavailable: typing.Union[MetaOapg.properties.holdings_unavailable, bool, schemas.Unset] = schemas.unset,
         _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],
     ) -> 'HoldingsStatus':
@@ -92,6 +101,7 @@ class HoldingsStatus(
             *args,
             initial_sync_completed=initial_sync_completed,
             last_successful_sync=last_successful_sync,
+            holdings_unavailable=holdings_unavailable,
             _configuration=_configuration,
             **kwargs,
         )

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/paths/accounts_account_id_positions_all/get.py

@@ -517,7 +517,7 @@ class GetAllAccountPositions(BaseApi, typing.Generic[TAuth]):
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.  """
+        """ Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.  """
         args = self._get_all_account_positions_mapped_args(
             path_params=path_params,
             account_id=account_id,
@@ -574,7 +574,7 @@ class ApiForget(BaseApi, typing.Generic[TAuth]):
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.  """
+        """ Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.  """
         args = self._get_all_account_positions_mapped_args(
             path_params=path_params,
             account_id=account_id,

{snaptrade_python_sdk-12.0.2 → snaptrade_python_sdk-12.0.3}/snaptrade_client/type/holdings_status.py

@@ -26,5 +26,8 @@ class OptionalHoldingsStatus(TypedDict, total=False):
 
     last_successful_sync: HoldingsSyncStatusDateNullable
 
+    # Indicates that the brokerage does not expose this account's holdings to SnapTrade, so the empty positions and balances reported for it do not mean the account is empty. This is set for accounts served by a separate brokerage system that we cannot read, such as Vanguard employer-sponsored retirement plans. When this is `true`, prefer the account's total value over the sum of its positions and cash, and note that `initial_sync_completed` and `last_successful_sync` may still reflect an earlier sync. 
+    holdings_unavailable: bool
+
 class HoldingsStatus(RequiredHoldingsStatus, OptionalHoldingsStatus):
     pass