snaptrade-python-sdk 11.0.125__tar.gz → 11.0.127__tar.gz

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 11.0.125
+Version: 11.0.127
 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.125-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.125)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.127-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.127)
 [![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/)
 
@@ -109,7 +109,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.125
+pip install snaptrade-python-sdk==11.0.127
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -401,7 +401,7 @@ get_user_account_details_response = (
 
 ### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
 
-Returns the detail of a single order in the specified account.
+Returns the detail of a single order using the external order ID provided in the request body.
 
 This endpoint is always realtime and does not rely on cached data.
 
@@ -413,31 +413,36 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
 ```python
 get_user_account_order_detail_response = (
     snaptrade.account_information.get_user_account_order_detail(
+        external_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
         user_id="snaptrade-user-123",
         user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
-        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
-        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
     )
 )
 ```
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### user_id: `str`<a id="user_id-str"></a>
+##### external_order_id: `str`<a id="external_order_id-str"></a>
 
-##### user_secret: `str`<a id="user_secret-str"></a>
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
 
 ##### account_id: `str`<a id="account_id-str"></a>
 
-##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
 
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
 #### 🔄 Return<a id="🔄-return"></a>
 
 [`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/orders/{brokerageOrderId}` `get`
+`/accounts/{accountId}/orders/details` `post`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 
@@ -1051,7 +1056,7 @@ list_brokerage_authorizations_response = (
 Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
 This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
 
-**Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05**
+**Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/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.125-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.125)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.127-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.127)
 [![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/)
 
@@ -86,7 +86,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.125
+pip install snaptrade-python-sdk==11.0.127
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -378,7 +378,7 @@ get_user_account_details_response = (
 
 ### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
 
-Returns the detail of a single order in the specified account.
+Returns the detail of a single order using the external order ID provided in the request body.
 
 This endpoint is always realtime and does not rely on cached data.
 
@@ -390,31 +390,36 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
 ```python
 get_user_account_order_detail_response = (
     snaptrade.account_information.get_user_account_order_detail(
+        external_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
         user_id="snaptrade-user-123",
         user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
-        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
-        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
     )
 )
 ```
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### user_id: `str`<a id="user_id-str"></a>
+##### external_order_id: `str`<a id="external_order_id-str"></a>
 
-##### user_secret: `str`<a id="user_secret-str"></a>
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
 
 ##### account_id: `str`<a id="account_id-str"></a>
 
-##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
 
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
 #### 🔄 Return<a id="🔄-return"></a>
 
 [`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/orders/{brokerageOrderId}` `get`
+`/accounts/{accountId}/orders/details` `post`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 
@@ -1028,7 +1033,7 @@ list_brokerage_authorizations_response = (
 Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
 This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
 
-**Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05**
+**Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/pyproject.toml

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

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/snaptrade_client/__init__.py

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

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

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/snaptrade_client/apis/path_to_api.py

@@ -20,10 +20,10 @@ from snaptrade_client.apis.paths.accounts_account_id import AccountsAccountId
 from snaptrade_client.apis.paths.accounts_account_id_balances import AccountsAccountIdBalances
 from snaptrade_client.apis.paths.accounts_account_id_positions import AccountsAccountIdPositions
 from snaptrade_client.apis.paths.accounts_account_id_orders import AccountsAccountIdOrders
-from snaptrade_client.apis.paths.accounts_account_id_orders_brokerage_order_id import AccountsAccountIdOrdersBrokerageOrderId
 from snaptrade_client.apis.paths.accounts_account_id_recent_orders import AccountsAccountIdRecentOrders
 from snaptrade_client.apis.paths.accounts_account_id_return_rates import AccountsAccountIdReturnRates
 from snaptrade_client.apis.paths.accounts_account_id_activities import AccountsAccountIdActivities
+from snaptrade_client.apis.paths.accounts_account_id_orders_details import AccountsAccountIdOrdersDetails
 from snaptrade_client.apis.paths.accounts_account_id_options import AccountsAccountIdOptions
 from snaptrade_client.apis.paths.accounts_account_id_options_chain import AccountsAccountIdOptionsChain
 from snaptrade_client.apis.paths.activities import Activities
@@ -76,10 +76,10 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.ACCOUNTS_ACCOUNT_ID_BALANCES: AccountsAccountIdBalances,
         PathValues.ACCOUNTS_ACCOUNT_ID_POSITIONS: AccountsAccountIdPositions,
         PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS: AccountsAccountIdOrders,
-        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID: AccountsAccountIdOrdersBrokerageOrderId,
         PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS: AccountsAccountIdRecentOrders,
         PathValues.ACCOUNTS_ACCOUNT_ID_RETURN_RATES: AccountsAccountIdReturnRates,
         PathValues.ACCOUNTS_ACCOUNT_ID_ACTIVITIES: AccountsAccountIdActivities,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS: AccountsAccountIdOrdersDetails,
         PathValues.ACCOUNTS_ACCOUNT_ID_OPTIONS: AccountsAccountIdOptions,
         PathValues.ACCOUNTS_ACCOUNT_ID_OPTIONS_CHAIN: AccountsAccountIdOptionsChain,
         PathValues.ACTIVITIES: Activities,
@@ -133,10 +133,10 @@ path_to_api = PathToApi(
         PathValues.ACCOUNTS_ACCOUNT_ID_BALANCES: AccountsAccountIdBalances,
         PathValues.ACCOUNTS_ACCOUNT_ID_POSITIONS: AccountsAccountIdPositions,
         PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS: AccountsAccountIdOrders,
-        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID: AccountsAccountIdOrdersBrokerageOrderId,
         PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS: AccountsAccountIdRecentOrders,
         PathValues.ACCOUNTS_ACCOUNT_ID_RETURN_RATES: AccountsAccountIdReturnRates,
         PathValues.ACCOUNTS_ACCOUNT_ID_ACTIVITIES: AccountsAccountIdActivities,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS: AccountsAccountIdOrdersDetails,
         PathValues.ACCOUNTS_ACCOUNT_ID_OPTIONS: AccountsAccountIdOptions,
         PathValues.ACCOUNTS_ACCOUNT_ID_OPTIONS_CHAIN: AccountsAccountIdOptionsChain,
         PathValues.ACTIVITIES: Activities,

snaptrade_python_sdk-11.0.127/snaptrade_client/apis/paths/accounts_account_id_orders_details.py

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

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/snaptrade_client/apis/tags/account_information_api_generated.py

@@ -13,7 +13,7 @@ from snaptrade_client.paths.accounts_account_id_activities.get import GetAccount
 from snaptrade_client.paths.holdings.get import GetAllUserHoldings
 from snaptrade_client.paths.accounts_account_id_balances.get import GetUserAccountBalance
 from snaptrade_client.paths.accounts_account_id.get import GetUserAccountDetails
-from snaptrade_client.paths.accounts_account_id_orders_brokerage_order_id.get import GetUserAccountOrderDetail
+from snaptrade_client.paths.accounts_account_id_orders_details.post import GetUserAccountOrderDetail
 from snaptrade_client.paths.accounts_account_id_orders.get import GetUserAccountOrders
 from snaptrade_client.paths.accounts_account_id_positions.get import GetUserAccountPositions
 from snaptrade_client.paths.accounts_account_id_recent_orders.get import GetUserAccountRecentOrders

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/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.125".\
+               "SDK Package Version: 11.0.127".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/snaptrade_client/operation_parameter_map.py

@@ -66,19 +66,19 @@ operation_parameter_map = {
             },
         ]
     },
-    '/accounts/{accountId}/orders/{brokerageOrderId}-GET': {
+    '/accounts/{accountId}/orders/details-POST': {
         'parameters': [
             {
-                'name': 'userId'
+                'name': 'external_order_id'
             },
             {
-                'name': 'userSecret'
+                'name': 'accountId'
             },
             {
-                'name': 'accountId'
+                'name': 'userId'
             },
             {
-                'name': 'brokerageOrderId'
+                'name': 'userSecret'
             },
         ]
     },

{snaptrade_python_sdk-11.0.125 → snaptrade_python_sdk-11.0.127}/snaptrade_client/paths/__init__.py

@@ -25,10 +25,10 @@ class PathValues(str, enum.Enum):
     ACCOUNTS_ACCOUNT_ID_BALANCES = "/accounts/{accountId}/balances"
     ACCOUNTS_ACCOUNT_ID_POSITIONS = "/accounts/{accountId}/positions"
     ACCOUNTS_ACCOUNT_ID_ORDERS = "/accounts/{accountId}/orders"
-    ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID = "/accounts/{accountId}/orders/{brokerageOrderId}"
     ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS = "/accounts/{accountId}/recentOrders"
     ACCOUNTS_ACCOUNT_ID_RETURN_RATES = "/accounts/{accountId}/returnRates"
     ACCOUNTS_ACCOUNT_ID_ACTIVITIES = "/accounts/{accountId}/activities"
+    ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS = "/accounts/{accountId}/orders/details"
     ACCOUNTS_ACCOUNT_ID_OPTIONS = "/accounts/{accountId}/options"
     ACCOUNTS_ACCOUNT_ID_OPTIONS_CHAIN = "/accounts/{accountId}/optionsChain"
     ACTIVITIES = "/activities"

snaptrade_python_sdk-11.0.127/snaptrade_client/paths/accounts_account_id_orders_details/__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_orders_details import Api
+
+from snaptrade_client.paths import PathValues
+
+path = PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS