snaptrade-python-sdk 10.9.0__py3-none-any.whl → 11.0.152__py3-none-any.whl

snaptrade_client/model/time_in_force_strict.py

@@ -0,0 +1,65 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+
+class TimeInForceStrict(
+    schemas.EnumBase,
+    schemas.StrSchema
+):
+    """
+    This class is auto generated by Konfig (https://konfigthis.com)
+
+    The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:
+  - `Day` - Day. The order is valid only for the trading day on which it is placed.
+  - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.
+  - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
+  - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.
+
+    """
+
+
+    class MetaOapg:
+        enum_value_to_name = {
+            "FOK": "FOK",
+            "Day": "DAY",
+            "GTC": "GTC",
+            "IOC": "IOC",
+        }
+    
+    @schemas.classproperty
+    def FOK(cls):
+        return cls("FOK")
+    
+    @schemas.classproperty
+    def DAY(cls):
+        return cls("Day")
+    
+    @schemas.classproperty
+    def GTC(cls):
+        return cls("GTC")
+    
+    @schemas.classproperty
+    def IOC(cls):
+        return cls("IOC")

snaptrade_client/model/time_in_force_strict.pyi

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+
+class TimeInForceStrict(
+    schemas.EnumBase,
+    schemas.StrSchema
+):
+    """
+    This class is auto generated by Konfig (https://konfigthis.com)
+
+    The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:
+  - `Day` - Day. The order is valid only for the trading day on which it is placed.
+  - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.
+  - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
+  - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.
+
+    """
+    
+    @schemas.classproperty
+    def FOK(cls):
+        return cls("FOK")
+    
+    @schemas.classproperty
+    def DAY(cls):
+        return cls("Day")
+    
+    @schemas.classproperty
+    def GTC(cls):
+        return cls("GTC")
+    
+    @schemas.classproperty
+    def IOC(cls):
+        return cls("IOC")

snaptrade_client/model/{email.py → trade_id.py}

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from datetime import date, datetime  # noqa: F401
@@ -22,4 +22,4 @@ import uuid  # noqa: F401
 import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
-Email = schemas.StrSchema
+TradeID = schemas.UUIDSchema

snaptrade_client/model/{email.pyi → trade_id.pyi}

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from datetime import date, datetime  # noqa: F401
@@ -22,4 +22,4 @@ import uuid  # noqa: F401
 import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
-Email = schemas.StrSchema
+TradeID = schemas.UUIDSchema

snaptrade_client/model/trading_instrument.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+
+class TradingInstrument(
+    schemas.DictSchema
+):
+    """
+    This class is auto generated by Konfig (https://konfigthis.com)
+    """
+
+
+    class MetaOapg:
+        required = {
+            "symbol",
+            "type",
+        }
+        
+        class properties:
+            symbol = schemas.StrSchema
+            
+            
+            class type(
+                schemas.EnumBase,
+                schemas.StrSchema
+            ):
+            
+            
+                class MetaOapg:
+                    enum_value_to_name = {
+                        "EQUITY": "EQUITY",
+                        "OPTION": "OPTION",
+                        "CRYPTOCURRENCY": "CRYPTOCURRENCY",
+                        "CRYPTOCURRENCY_PAIR": "CRYPTOCURRENCY_PAIR",
+                    }
+                
+                @schemas.classproperty
+                def EQUITY(cls):
+                    return cls("EQUITY")
+                
+                @schemas.classproperty
+                def OPTION(cls):
+                    return cls("OPTION")
+                
+                @schemas.classproperty
+                def CRYPTOCURRENCY(cls):
+                    return cls("CRYPTOCURRENCY")
+                
+                @schemas.classproperty
+                def CRYPTOCURRENCY_PAIR(cls):
+                    return cls("CRYPTOCURRENCY_PAIR")
+            __annotations__ = {
+                "symbol": symbol,
+                "type": type,
+            }
+        additional_properties = schemas.AnyTypeSchema
+    
+    symbol: MetaOapg.properties.symbol
+    type: MetaOapg.properties.type
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["symbol"]) -> MetaOapg.properties.symbol: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ...
+    
+    @typing.overload
+    def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
+    
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["type"], str, ]):
+        # dict_instance[name] accessor
+        return super().__getitem__(name)
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["symbol"]) -> MetaOapg.properties.symbol: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ...
+    
+    @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["type"], str, ]):
+        return super().get_item_oapg(name)
+
+    def __new__(
+        cls,
+        *args: typing.Union[dict, frozendict.frozendict, ],
+        symbol: typing.Union[MetaOapg.properties.symbol, str, ],
+        type: typing.Union[MetaOapg.properties.type, str, ],
+        _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, ],
+    ) -> 'TradingInstrument':
+        return super().__new__(
+            cls,
+            *args,
+            symbol=symbol,
+            type=type,
+            _configuration=_configuration,
+            **kwargs,
+        )

snaptrade_client/model/{brokerage_authorization_type.pyi → trading_instrument.pyi}

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from datetime import date, datetime  # noqa: F401
@@ -24,7 +24,7 @@ import frozendict  # noqa: F401
 from snaptrade_client import schemas  # noqa: F401
 
 
-class BrokerageAuthorizationType(
+class TradingInstrument(
     schemas.DictSchema
 ):
     """
@@ -33,8 +33,13 @@ class BrokerageAuthorizationType(
 
 
     class MetaOapg:
+        required = {
+            "symbol",
+            "type",
+        }
         
         class properties:
+            symbol = schemas.StrSchema
             
             
             class type(
@@ -43,46 +48,66 @@ class BrokerageAuthorizationType(
             ):
                 
                 @schemas.classproperty
-                def READ(cls):
-                    return cls("read")
+                def EQUITY(cls):
+                    return cls("EQUITY")
                 
                 @schemas.classproperty
-                def TRADE(cls):
-                    return cls("trade")
+                def OPTION(cls):
+                    return cls("OPTION")
+                
+                @schemas.classproperty
+                def CRYPTOCURRENCY(cls):
+                    return cls("CRYPTOCURRENCY")
+                
+                @schemas.classproperty
+                def CRYPTOCURRENCY_PAIR(cls):
+                    return cls("CRYPTOCURRENCY_PAIR")
             __annotations__ = {
+                "symbol": symbol,
                 "type": type,
             }
         additional_properties = schemas.AnyTypeSchema
     
+    symbol: MetaOapg.properties.symbol
+    type: MetaOapg.properties.type
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["symbol"]) -> MetaOapg.properties.symbol: ...
+    
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ...
     
     @typing.overload
     def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
     
-    def __getitem__(self, name: typing.Union[typing_extensions.Literal["type"], str, ]):
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["type"], str, ]):
         # dict_instance[name] accessor
         return super().__getitem__(name)
     
     @typing.overload
-    def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ...
+    def get_item_oapg(self, name: typing_extensions.Literal["symbol"]) -> MetaOapg.properties.symbol: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ...
     
     @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["type"], str, ]):
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["type"], str, ]):
         return super().get_item_oapg(name)
 
     def __new__(
         cls,
         *args: typing.Union[dict, frozendict.frozendict, ],
-        type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset,
+        symbol: typing.Union[MetaOapg.properties.symbol, str, ],
+        type: typing.Union[MetaOapg.properties.type, str, ],
         _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, ],
-    ) -> 'BrokerageAuthorizationType':
+    ) -> 'TradingInstrument':
         return super().__new__(
             cls,
             *args,
+            symbol=symbol,
             type=type,
             _configuration=_configuration,
             **kwargs,

snaptrade_client/model/trading_session.py

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+
+class TradingSession(
+    schemas.EnumBase,
+    schemas.StrSchema
+):
+    """
+    This class is auto generated by Konfig (https://konfigthis.com)
+
+    The trading session for the order. This field indicates which market session the order will be placed in. This is only available for certain brokerages. Defaults to REGULAR. Here are the supported values:
+  - `REGULAR` - Regular trading hours.
+  - `EXTENDED` - Extended trading hours.
+
+    """
+
+
+    class MetaOapg:
+        enum_value_to_name = {
+            "REGULAR": "REGULAR",
+            "EXTENDED": "EXTENDED",
+        }
+    
+    @schemas.classproperty
+    def REGULAR(cls):
+        return cls("REGULAR")
+    
+    @schemas.classproperty
+    def EXTENDED(cls):
+        return cls("EXTENDED")

snaptrade_client/model/trading_session.pyi

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+
+class TradingSession(
+    schemas.EnumBase,
+    schemas.StrSchema
+):
+    """
+    This class is auto generated by Konfig (https://konfigthis.com)
+
+    The trading session for the order. This field indicates which market session the order will be placed in. This is only available for certain brokerages. Defaults to REGULAR. Here are the supported values:
+  - `REGULAR` - Regular trading hours.
+  - `EXTENDED` - Extended trading hours.
+
+    """
+    
+    @schemas.classproperty
+    def REGULAR(cls):
+        return cls("REGULAR")
+    
+    @schemas.classproperty
+    def EXTENDED(cls):
+        return cls("EXTENDED")

snaptrade_client/model/transactions_status.py

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from datetime import date, datetime  # noqa: F401
@@ -30,7 +30,11 @@ class TransactionsStatus(
     """
     This class is auto generated by Konfig (https://konfigthis.com)
 
-    Status of account transaction sync
+    Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions:
+1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage.
+2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage.
+3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
+
     """
 
 
@@ -40,11 +44,48 @@ class TransactionsStatus(
             initial_sync_completed = schemas.BoolSchema
         
             @staticmethod
-            def last_successful_sync() -> typing.Type['SyncStatusDate']:
-                return SyncStatusDate
+            def last_successful_sync() -> typing.Type['SyncStatusDateNullable']:
+                return SyncStatusDateNullable
+            
+            
+            class first_transaction_date(
+                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 [
+                            SyncStatusDate,
+                        ]
+            
+            
+                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],
+                ) -> 'first_transaction_date':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                        **kwargs,
+                    )
             __annotations__ = {
                 "initial_sync_completed": initial_sync_completed,
                 "last_successful_sync": last_successful_sync,
+                "first_transaction_date": first_transaction_date,
             }
 
     
@@ -52,12 +93,15 @@ class TransactionsStatus(
     def __getitem__(self, name: typing_extensions.Literal["initial_sync_completed"]) -> MetaOapg.properties.initial_sync_completed: ...
     
     @typing.overload
-    def __getitem__(self, name: typing_extensions.Literal["last_successful_sync"]) -> 'SyncStatusDate': ...
+    def __getitem__(self, name: typing_extensions.Literal["last_successful_sync"]) -> 'SyncStatusDateNullable': ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["first_transaction_date"]) -> MetaOapg.properties.first_transaction_date: ...
     
     @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", "first_transaction_date", ], str]):
         # dict_instance[name] accessor
         return super().__getitem__(name)
     
@@ -66,12 +110,15 @@ class TransactionsStatus(
     def get_item_oapg(self, name: typing_extensions.Literal["initial_sync_completed"]) -> typing.Union[MetaOapg.properties.initial_sync_completed, schemas.Unset]: ...
     
     @typing.overload
-    def get_item_oapg(self, name: typing_extensions.Literal["last_successful_sync"]) -> typing.Union['SyncStatusDate', schemas.Unset]: ...
+    def get_item_oapg(self, name: typing_extensions.Literal["last_successful_sync"]) -> typing.Union['SyncStatusDateNullable', schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["first_transaction_date"]) -> typing.Union[MetaOapg.properties.first_transaction_date, 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", "first_transaction_date", ], str]):
         return super().get_item_oapg(name)
     
 
@@ -79,7 +126,8 @@ class TransactionsStatus(
         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, ],
         initial_sync_completed: typing.Union[MetaOapg.properties.initial_sync_completed, bool, schemas.Unset] = schemas.unset,
-        last_successful_sync: typing.Union['SyncStatusDate', schemas.Unset] = schemas.unset,
+        last_successful_sync: typing.Union['SyncStatusDateNullable', schemas.Unset] = schemas.unset,
+        first_transaction_date: typing.Union[MetaOapg.properties.first_transaction_date, 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[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
     ) -> 'TransactionsStatus':
@@ -88,8 +136,10 @@ class TransactionsStatus(
             *args,
             initial_sync_completed=initial_sync_completed,
             last_successful_sync=last_successful_sync,
+            first_transaction_date=first_transaction_date,
             _configuration=_configuration,
             **kwargs,
         )
 
 from snaptrade_client.model.sync_status_date import SyncStatusDate
+from snaptrade_client.model.sync_status_date_nullable import SyncStatusDateNullable