snaptrade-python-sdk 11.0.196__tar.gz → 11.0.197__tar.gz

snaptrade_python_sdk-11.0.196/README.md → snaptrade_python_sdk-11.0.197/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.1
+Name: snaptrade-python-sdk
+Version: 11.0.197
+Summary: Client for SnapTrade
+License: MIT
+Author: SnapTrade
+Author-email: api@snaptrade.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: aiohttp (>=3.10.11,<4.0.0)
+Requires-Dist: certifi (>=2023.7.22)
+Requires-Dist: cryptography (>=43.0.3)
+Requires-Dist: frozendict (>=2.3.4,<3.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.13.2,<5)
+Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
+Description-Content-Type: text/markdown
+
 <div align="center">
 
 [![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
@@ -7,7 +30,7 @@
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.196-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.196)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.197-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.197)
 [![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/)
 
@@ -51,6 +74,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
+  * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
@@ -92,7 +116,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.196
+pip install snaptrade-python-sdk==11.0.197
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -575,7 +599,7 @@ get_user_account_orders_response = (
 
 ##### state: `str`<a id="state-str"></a>
 
-defaults value is set to \"all\"
+defaults to \"all\"
 
 ##### days: `int`<a id="days-int"></a>
 
@@ -1398,6 +1422,43 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
+### `snaptrade.connections.sync_brokerage_authorization_transactions`<a id="snaptradeconnectionssync_brokerage_authorization_transactions"></a>
+
+Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+sync_brokerage_authorization_transactions_response = (
+    snaptrade.connections.sync_brokerage_authorization_transactions(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorizationTransactionsSyncConfirmation`](./snaptrade_client/type/brokerage_authorization_transactions_sync_confirmation.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/transactions/sync` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
@@ -2907,3 +2968,4 @@ Optional frequency for the rate of return chart (defaults to monthly). Possible
 
 ## Author<a id="author"></a>
 This Python package is automatically generated by [Konfig](https://konfigthis.com)
+

snaptrade_python_sdk-11.0.196/PKG-INFO → snaptrade_python_sdk-11.0.197/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: snaptrade-python-sdk
-Version: 11.0.196
-Summary: Client for SnapTrade
-License: MIT
-Author: SnapTrade
-Author-email: api@snaptrade.com
-Requires-Python: >=3.8,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: aiohttp (>=3.10.11,<4.0.0)
-Requires-Dist: certifi (>=2023.7.22)
-Requires-Dist: cryptography (>=43.0.3)
-Requires-Dist: frozendict (>=2.3.4,<3.0.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
-Requires-Dist: typing_extensions (>=4.13.2,<5)
-Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
-Description-Content-Type: text/markdown
-
 <div align="center">
 
 [![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
@@ -30,7 +7,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.196-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.196)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.197-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.197)
 [![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/)
 
@@ -74,6 +51,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
+  * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
@@ -115,7 +93,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.196
+pip install snaptrade-python-sdk==11.0.197
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -598,7 +576,7 @@ get_user_account_orders_response = (
 
 ##### state: `str`<a id="state-str"></a>
 
-defaults value is set to \"all\"
+defaults to \"all\"
 
 ##### days: `int`<a id="days-int"></a>
 
@@ -1421,6 +1399,43 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
+### `snaptrade.connections.sync_brokerage_authorization_transactions`<a id="snaptradeconnectionssync_brokerage_authorization_transactions"></a>
+
+Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+sync_brokerage_authorization_transactions_response = (
+    snaptrade.connections.sync_brokerage_authorization_transactions(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorizationTransactionsSyncConfirmation`](./snaptrade_client/type/brokerage_authorization_transactions_sync_confirmation.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/transactions/sync` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
@@ -2930,4 +2945,3 @@ Optional frequency for the rate of return chart (defaults to monthly). Possible
 
 ## Author<a id="author"></a>
 This Python package is automatically generated by [Konfig](https://konfigthis.com)
-

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/pyproject.toml

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

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/__init__.py

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

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/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.196/python'
+        self.user_agent = 'Konfig/11.0.197/python'
 
     def __enter__(self):
         return self

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/apis/path_to_api.py

@@ -12,6 +12,7 @@ from snaptrade_client.apis.paths.authorizations import Authorizations
 from snaptrade_client.apis.paths.authorizations_authorization_id import AuthorizationsAuthorizationId
 from snaptrade_client.apis.paths.connection_connection_id import ConnectionConnectionId
 from snaptrade_client.apis.paths.authorizations_authorization_id_refresh import AuthorizationsAuthorizationIdRefresh
+from snaptrade_client.apis.paths.authorizations_authorization_id_transactions_sync import AuthorizationsAuthorizationIdTransactionsSync
 from snaptrade_client.apis.paths.authorizations_authorization_id_disable import AuthorizationsAuthorizationIdDisable
 from snaptrade_client.apis.paths.authorizations_authorization_id_accounts import AuthorizationsAuthorizationIdAccounts
 from snaptrade_client.apis.paths.session_events import SessionEvents
@@ -74,6 +75,7 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID: AuthorizationsAuthorizationId,
         PathValues.CONNECTION_CONNECTION_ID: ConnectionConnectionId,
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_REFRESH: AuthorizationsAuthorizationIdRefresh,
+        PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_TRANSACTIONS_SYNC: AuthorizationsAuthorizationIdTransactionsSync,
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_DISABLE: AuthorizationsAuthorizationIdDisable,
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_ACCOUNTS: AuthorizationsAuthorizationIdAccounts,
         PathValues.SESSION_EVENTS: SessionEvents,
@@ -137,6 +139,7 @@ path_to_api = PathToApi(
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID: AuthorizationsAuthorizationId,
         PathValues.CONNECTION_CONNECTION_ID: ConnectionConnectionId,
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_REFRESH: AuthorizationsAuthorizationIdRefresh,
+        PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_TRANSACTIONS_SYNC: AuthorizationsAuthorizationIdTransactionsSync,
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_DISABLE: AuthorizationsAuthorizationIdDisable,
         PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_ACCOUNTS: AuthorizationsAuthorizationIdAccounts,
         PathValues.SESSION_EVENTS: SessionEvents,

snaptrade_python_sdk-11.0.197/snaptrade_client/apis/paths/authorizations_authorization_id_transactions_sync.py

@@ -0,0 +1,7 @@
+from snaptrade_client.paths.authorizations_authorization_id_transactions_sync.post import ApiForpost
+
+
+class AuthorizationsAuthorizationIdTransactionsSync(
+    ApiForpost,
+):
+    pass

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/apis/tags/connections_api_generated.py

@@ -18,6 +18,7 @@ from snaptrade_client.paths.authorizations_authorization_id_refresh.post import
 from snaptrade_client.paths.authorizations_authorization_id.delete import RemoveBrokerageAuthorization
 from snaptrade_client.paths.authorizations_authorization_id_return_rates.get import ReturnRates
 from snaptrade_client.paths.session_events.get import SessionEvents
+from snaptrade_client.paths.authorizations_authorization_id_transactions_sync.post import SyncBrokerageAuthorizationTransactions
 
 
 class ConnectionsApiGenerated(
@@ -30,6 +31,7 @@ class ConnectionsApiGenerated(
     RemoveBrokerageAuthorization,
     ReturnRates,
     SessionEvents,
+    SyncBrokerageAuthorizationTransactions,
 ):
     """NOTE:
     This class is auto generated by Konfig (https://konfigthis.com)

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/configuration.py

@@ -439,7 +439,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.196".\
+               "SDK Package Version: 11.0.197".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/model/account_value_history_item.py

@@ -30,7 +30,7 @@ class AccountValueHistoryItem(
     """
     This class is auto generated by Konfig (https://konfigthis.com)
 
-    The estimeated account value at a specific point in time.
+    The estimated account value at a specific point in time.
     """
 
 

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/model/account_value_history_item.pyi

@@ -30,7 +30,7 @@ class AccountValueHistoryItem(
     """
     This class is auto generated by Konfig (https://konfigthis.com)
 
-    The estimeated account value at a specific point in time.
+    The estimated account value at a specific point in time.
     """
 
 

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/operation_parameter_map.py

@@ -391,6 +391,19 @@ operation_parameter_map = {
             },
         ]
     },
+    '/authorizations/{authorizationId}/transactions/sync-POST': {
+        'parameters': [
+            {
+                'name': 'authorizationId'
+            },
+            {
+                'name': 'userId'
+            },
+            {
+                'name': 'userSecret'
+            },
+        ]
+    },
     '/accounts/{accountId}/options-GET': {
         'parameters': [
             {

{snaptrade_python_sdk-11.0.196 → snaptrade_python_sdk-11.0.197}/snaptrade_client/paths/__init__.py

@@ -17,6 +17,7 @@ class PathValues(str, enum.Enum):
     AUTHORIZATIONS_AUTHORIZATION_ID = "/authorizations/{authorizationId}"
     CONNECTION_CONNECTION_ID = "/connection/{connectionId}"
     AUTHORIZATIONS_AUTHORIZATION_ID_REFRESH = "/authorizations/{authorizationId}/refresh"
+    AUTHORIZATIONS_AUTHORIZATION_ID_TRANSACTIONS_SYNC = "/authorizations/{authorizationId}/transactions/sync"
     AUTHORIZATIONS_AUTHORIZATION_ID_DISABLE = "/authorizations/{authorizationId}/disable"
     AUTHORIZATIONS_AUTHORIZATION_ID_ACCOUNTS = "/authorizations/{authorizationId}/accounts"
     SESSION_EVENTS = "/sessionEvents"

snaptrade_python_sdk-11.0.197/snaptrade_client/paths/authorizations_authorization_id_transactions_sync/__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.authorizations_authorization_id_transactions_sync import Api
+
+from snaptrade_client.paths import PathValues
+
+path = PathValues.AUTHORIZATIONS_AUTHORIZATION_ID_TRANSACTIONS_SYNC