snaptrade-python-sdk 11.0.179__tar.gz → 11.0.180__tar.gz

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 11.0.179
+Version: 11.0.180
 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.179-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.179)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.180-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.180)
 [![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/)
 
@@ -115,7 +115,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.179
+pip install snaptrade-python-sdk==11.0.180
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -611,7 +611,7 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
 
 ### `snaptrade.account_information.get_user_account_return_rates`<a id="snaptradeaccount_informationget_user_account_return_rates"></a>
 
-Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+Returns a list of rate of return percents for a given account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -622,6 +622,7 @@ get_user_account_return_rates_response = (
         user_id="snaptrade-user-123",
         user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
         account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        timeframes="ALL,1Y",
     )
 )
 ```
@@ -634,6 +635,10 @@ get_user_account_return_rates_response = (
 
 ##### account_id: `str`<a id="account_id-str"></a>
 
+##### timeframes: `str`<a id="timeframes-str"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [`RateOfReturnResponse`](./snaptrade_client/type/rate_of_return_response.py)
@@ -1203,7 +1208,7 @@ snaptrade.connections.remove_brokerage_authorization(
 
 ### `snaptrade.connections.return_rates`<a id="snaptradeconnectionsreturn_rates"></a>
 
-Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+Returns a list of rate of return percents for a given connection.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1213,6 +1218,7 @@ return_rates_response = snaptrade.connections.return_rates(
     user_id="snaptrade-user-123",
     user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
     authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    timeframes="ALL,1Y",
 )
 ```
 
@@ -1224,6 +1230,10 @@ return_rates_response = snaptrade.connections.return_rates(
 
 ##### authorization_id: `str`<a id="authorization_id-str"></a>
 
+##### timeframes: `str`<a id="timeframes-str"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [`RateOfReturnResponse`](./snaptrade_client/type/rate_of_return_response.py)

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/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.179-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.179)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.180-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.180)
 [![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/)
 
@@ -92,7 +92,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.179
+pip install snaptrade-python-sdk==11.0.180
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -588,7 +588,7 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
 
 ### `snaptrade.account_information.get_user_account_return_rates`<a id="snaptradeaccount_informationget_user_account_return_rates"></a>
 
-Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+Returns a list of rate of return percents for a given account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -599,6 +599,7 @@ get_user_account_return_rates_response = (
         user_id="snaptrade-user-123",
         user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
         account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        timeframes="ALL,1Y",
     )
 )
 ```
@@ -611,6 +612,10 @@ get_user_account_return_rates_response = (
 
 ##### account_id: `str`<a id="account_id-str"></a>
 
+##### timeframes: `str`<a id="timeframes-str"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [`RateOfReturnResponse`](./snaptrade_client/type/rate_of_return_response.py)
@@ -1180,7 +1185,7 @@ snaptrade.connections.remove_brokerage_authorization(
 
 ### `snaptrade.connections.return_rates`<a id="snaptradeconnectionsreturn_rates"></a>
 
-Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+Returns a list of rate of return percents for a given connection.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1190,6 +1195,7 @@ return_rates_response = snaptrade.connections.return_rates(
     user_id="snaptrade-user-123",
     user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
     authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    timeframes="ALL,1Y",
 )
 ```
 
@@ -1201,6 +1207,10 @@ return_rates_response = snaptrade.connections.return_rates(
 
 ##### authorization_id: `str`<a id="authorization_id-str"></a>
 
+##### timeframes: `str`<a id="timeframes-str"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [`RateOfReturnResponse`](./snaptrade_client/type/rate_of_return_response.py)

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/pyproject.toml

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

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/snaptrade_client/__init__.py

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

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

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

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/snaptrade_client/model/rate_of_return_object.py

@@ -49,9 +49,10 @@ class RateOfReturnObject(
                     enum_value_to_name = {
                         "ALL": "ALL",
                         "1Y": "_1Y",
-                        "6M": "_6M",
-                        "3M": "_3M",
+                        "YTD": "YTD",
                         "1M": "_1M",
+                        "1W": "_1W",
+                        "1D": "_1D",
                     }
                 
                 @schemas.classproperty
@@ -63,16 +64,20 @@ class RateOfReturnObject(
                     return cls("1Y")
                 
                 @schemas.classproperty
-                def _6M(cls):
-                    return cls("6M")
-                
-                @schemas.classproperty
-                def _3M(cls):
-                    return cls("3M")
+                def YTD(cls):
+                    return cls("YTD")
                 
                 @schemas.classproperty
                 def _1M(cls):
                     return cls("1M")
+                
+                @schemas.classproperty
+                def _1W(cls):
+                    return cls("1W")
+                
+                @schemas.classproperty
+                def _1D(cls):
+                    return cls("1D")
             return_percent = schemas.NumberSchema
             created_date = schemas.DateTimeSchema
             __annotations__ = {

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/snaptrade_client/model/rate_of_return_object.pyi

@@ -53,16 +53,20 @@ class RateOfReturnObject(
                     return cls("1Y")
                 
                 @schemas.classproperty
-                def _6M(cls):
-                    return cls("6M")
-                
-                @schemas.classproperty
-                def _3M(cls):
-                    return cls("3M")
+                def YTD(cls):
+                    return cls("YTD")
                 
                 @schemas.classproperty
                 def _1M(cls):
                     return cls("1M")
+                
+                @schemas.classproperty
+                def _1W(cls):
+                    return cls("1W")
+                
+                @schemas.classproperty
+                def _1D(cls):
+                    return cls("1D")
             return_percent = schemas.NumberSchema
             created_date = schemas.DateTimeSchema
             __annotations__ = {

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/snaptrade_client/operation_parameter_map.py

@@ -141,6 +141,9 @@ operation_parameter_map = {
             {
                 'name': 'accountId'
             },
+            {
+                'name': 'timeframes'
+            },
         ]
     },
     '/accounts/{accountId}/holdings-GET': {
@@ -331,6 +334,9 @@ operation_parameter_map = {
             {
                 'name': 'authorizationId'
             },
+            {
+                'name': 'timeframes'
+            },
         ]
     },
     '/sessionEvents-GET': {

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/snaptrade_client/paths/accounts_account_id_return_rates/get.py

@@ -45,6 +45,7 @@ from . import path
 # Query params
 UserIdSchema = schemas.StrSchema
 UserSecretSchema = schemas.StrSchema
+TimeframesSchema = schemas.StrSchema
 RequestRequiredQueryParams = typing_extensions.TypedDict(
     'RequestRequiredQueryParams',
     {
@@ -55,6 +56,7 @@ RequestRequiredQueryParams = typing_extensions.TypedDict(
 RequestOptionalQueryParams = typing_extensions.TypedDict(
     'RequestOptionalQueryParams',
     {
+        'timeframes': typing.Union[TimeframesSchema, str, ],
     },
     total=False
 )
@@ -78,6 +80,12 @@ request_query_user_secret = api_client.QueryParameter(
     required=True,
     explode=True,
 )
+request_query_timeframes = api_client.QueryParameter(
+    name="timeframes",
+    style=api_client.ParameterStyle.FORM,
+    schema=TimeframesSchema,
+    explode=True,
+)
 # Path params
 AccountIdSchema = schemas.UUIDSchema
 RequestRequiredPathParams = typing_extensions.TypedDict(
@@ -189,6 +197,7 @@ class BaseApi(api_client.Api):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> api_client.MappedArgs:
@@ -199,6 +208,8 @@ class BaseApi(api_client.Api):
             _query_params["userId"] = user_id
         if user_secret is not None:
             _query_params["userSecret"] = user_secret
+        if timeframes is not None:
+            _query_params["timeframes"] = timeframes
         if account_id is not None:
             _path_params["accountId"] = account_id
         args.query = query_params if query_params else _query_params
@@ -246,6 +257,7 @@ class BaseApi(api_client.Api):
         for parameter in (
             request_query_user_id,
             request_query_user_secret,
+            request_query_timeframes,
         ):
             parameter_data = query_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -374,6 +386,7 @@ class BaseApi(api_client.Api):
         for parameter in (
             request_query_user_id,
             request_query_user_secret,
+            request_query_timeframes,
         ):
             parameter_data = query_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -440,6 +453,7 @@ class GetUserAccountReturnRates(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -454,6 +468,7 @@ class GetUserAccountReturnRates(BaseApi):
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return await self._aget_user_account_return_rates_oapg(
             query_params=args.query,
@@ -466,19 +481,21 @@ class GetUserAccountReturnRates(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"  """
+        """ Returns a list of rate of return percents for a given account.  """
         args = self._get_user_account_return_rates_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return self._get_user_account_return_rates_oapg(
             query_params=args.query,
@@ -493,6 +510,7 @@ class ApiForget(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -507,6 +525,7 @@ class ApiForget(BaseApi):
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return await self._aget_user_account_return_rates_oapg(
             query_params=args.query,
@@ -519,19 +538,21 @@ class ApiForget(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"  """
+        """ Returns a list of rate of return percents for a given account.  """
         args = self._get_user_account_return_rates_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return self._get_user_account_return_rates_oapg(
             query_params=args.query,

{snaptrade_python_sdk-11.0.179 → snaptrade_python_sdk-11.0.180}/snaptrade_client/paths/accounts_account_id_return_rates/get.pyi

@@ -43,6 +43,7 @@ from snaptrade_client.type.model500_unexpected_exception_response import Model50
 # Query params
 UserIdSchema = schemas.StrSchema
 UserSecretSchema = schemas.StrSchema
+TimeframesSchema = schemas.StrSchema
 RequestRequiredQueryParams = typing_extensions.TypedDict(
     'RequestRequiredQueryParams',
     {
@@ -53,6 +54,7 @@ RequestRequiredQueryParams = typing_extensions.TypedDict(
 RequestOptionalQueryParams = typing_extensions.TypedDict(
     'RequestOptionalQueryParams',
     {
+        'timeframes': typing.Union[TimeframesSchema, str, ],
     },
     total=False
 )
@@ -76,6 +78,12 @@ request_query_user_secret = api_client.QueryParameter(
     required=True,
     explode=True,
 )
+request_query_timeframes = api_client.QueryParameter(
+    name="timeframes",
+    style=api_client.ParameterStyle.FORM,
+    schema=TimeframesSchema,
+    explode=True,
+)
 # Path params
 AccountIdSchema = schemas.UUIDSchema
 RequestRequiredPathParams = typing_extensions.TypedDict(
@@ -177,6 +185,7 @@ class BaseApi(api_client.Api):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> api_client.MappedArgs:
@@ -187,6 +196,8 @@ class BaseApi(api_client.Api):
             _query_params["userId"] = user_id
         if user_secret is not None:
             _query_params["userSecret"] = user_secret
+        if timeframes is not None:
+            _query_params["timeframes"] = timeframes
         if account_id is not None:
             _path_params["accountId"] = account_id
         args.query = query_params if query_params else _query_params
@@ -234,6 +245,7 @@ class BaseApi(api_client.Api):
         for parameter in (
             request_query_user_id,
             request_query_user_secret,
+            request_query_timeframes,
         ):
             parameter_data = query_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -362,6 +374,7 @@ class BaseApi(api_client.Api):
         for parameter in (
             request_query_user_id,
             request_query_user_secret,
+            request_query_timeframes,
         ):
             parameter_data = query_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -428,6 +441,7 @@ class GetUserAccountReturnRates(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -442,6 +456,7 @@ class GetUserAccountReturnRates(BaseApi):
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return await self._aget_user_account_return_rates_oapg(
             query_params=args.query,
@@ -454,19 +469,21 @@ class GetUserAccountReturnRates(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"  """
+        """ Returns a list of rate of return percents for a given account.  """
         args = self._get_user_account_return_rates_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return self._get_user_account_return_rates_oapg(
             query_params=args.query,
@@ -481,6 +498,7 @@ class ApiForget(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -495,6 +513,7 @@ class ApiForget(BaseApi):
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return await self._aget_user_account_return_rates_oapg(
             query_params=args.query,
@@ -507,19 +526,21 @@ class ApiForget(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
+        timeframes: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"  """
+        """ Returns a list of rate of return percents for a given account.  """
         args = self._get_user_account_return_rates_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
+            timeframes=timeframes,
         )
         return self._get_user_account_return_rates_oapg(
             query_params=args.query,