snaptrade-python-sdk 11.0.126__py3-none-any.whl → 11.0.128__py3-none-any.whl

snaptrade_client/paths/{accounts_account_id_orders_brokerage_order_id/get.pyi → accounts_account_id_orders_details/post.pyi}

@@ -32,10 +32,12 @@ import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
 
+from snaptrade_client.model.model400_failed_request_response import Model400FailedRequestResponse as Model400FailedRequestResponseSchema
 from snaptrade_client.model.account_order_record import AccountOrderRecord as AccountOrderRecordSchema
 from snaptrade_client.model.model500_unexpected_exception_response import Model500UnexpectedExceptionResponse as Model500UnexpectedExceptionResponseSchema
 from snaptrade_client.model.model404_failed_request_response import Model404FailedRequestResponse as Model404FailedRequestResponseSchema
 
+from snaptrade_client.type.model400_failed_request_response import Model400FailedRequestResponse
 from snaptrade_client.type.model500_unexpected_exception_response import Model500UnexpectedExceptionResponse
 from snaptrade_client.type.account_order_record import AccountOrderRecord
 from snaptrade_client.type.model404_failed_request_response import Model404FailedRequestResponse
@@ -78,12 +80,10 @@ request_query_user_secret = api_client.QueryParameter(
 )
 # Path params
 AccountIdSchema = schemas.UUIDSchema
-BrokerageOrderIdSchema = schemas.StrSchema
 RequestRequiredPathParams = typing_extensions.TypedDict(
     'RequestRequiredPathParams',
     {
         'accountId': typing.Union[AccountIdSchema, str, uuid.UUID, ],
-        'brokerageOrderId': typing.Union[BrokerageOrderIdSchema, str, ],
     }
 )
 RequestOptionalPathParams = typing_extensions.TypedDict(
@@ -104,10 +104,69 @@ request_path_account_id = api_client.PathParameter(
     schema=AccountIdSchema,
     required=True,
 )
-request_path_brokerage_order_id = api_client.PathParameter(
-    name="brokerageOrderId",
-    style=api_client.ParameterStyle.SIMPLE,
-    schema=BrokerageOrderIdSchema,
+# body param
+
+
+class SchemaForRequestBodyApplicationJson(
+    schemas.DictSchema
+):
+
+
+    class MetaOapg:
+        required = {
+            "external_order_id",
+        }
+        
+        class properties:
+            external_order_id = schemas.StrSchema
+            __annotations__ = {
+                "external_order_id": external_order_id,
+            }
+    
+    external_order_id: MetaOapg.properties.external_order_id
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["external_order_id"]) -> MetaOapg.properties.external_order_id: ...
+    
+    @typing.overload
+    def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
+    
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["external_order_id", ], str]):
+        # dict_instance[name] accessor
+        return super().__getitem__(name)
+    
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["external_order_id"]) -> MetaOapg.properties.external_order_id: ...
+    
+    @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["external_order_id", ], str]):
+        return super().get_item_oapg(name)
+    
+
+    def __new__(
+        cls,
+        *args: typing.Union[dict, frozendict.frozendict, ],
+        external_order_id: typing.Union[MetaOapg.properties.external_order_id, str, ],
+        _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],
+    ) -> 'SchemaForRequestBodyApplicationJson':
+        return super().__new__(
+            cls,
+            *args,
+            external_order_id=external_order_id,
+            _configuration=_configuration,
+            **kwargs,
+        )
+
+
+request_body_typing_any = api_client.RequestBody(
+    content={
+        'application/json': api_client.MediaType(
+            schema=SchemaForRequestBodyApplicationJson),
+    },
     required=True,
 )
 SchemaFor200ResponseBodyApplicationJson = AccountOrderRecordSchema
@@ -131,6 +190,27 @@ _response_for_200 = api_client.OpenApiResponse(
             schema=SchemaFor200ResponseBodyApplicationJson),
     },
 )
+SchemaFor400ResponseBodyApplicationJson = Model400FailedRequestResponseSchema
+
+
+@dataclass
+class ApiResponseFor400(api_client.ApiResponse):
+    body: Model400FailedRequestResponse
+
+
+@dataclass
+class ApiResponseFor400Async(api_client.AsyncApiResponse):
+    body: Model400FailedRequestResponse
+
+
+_response_for_400 = api_client.OpenApiResponse(
+    response_cls=ApiResponseFor400,
+    response_cls_async=ApiResponseFor400Async,
+    content={
+        'application/json': api_client.MediaType(
+            schema=SchemaFor400ResponseBodyApplicationJson),
+    },
+)
 SchemaFor404ResponseBodyApplicationJson = Model404FailedRequestResponseSchema
 
 
@@ -182,35 +262,40 @@ class BaseApi(api_client.Api):
 
     def _get_user_account_order_detail_mapped_args(
         self,
+        body: typing.Optional[typing.Any] = None,
+        external_order_id: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
-        account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> api_client.MappedArgs:
         args: api_client.MappedArgs = api_client.MappedArgs()
         _query_params = {}
         _path_params = {}
+        _body = {}
+        if external_order_id is not None:
+            _body["external_order_id"] = external_order_id
+        args.body = body if body is not None else _body
         if user_id is not None:
             _query_params["userId"] = user_id
         if user_secret is not None:
             _query_params["userSecret"] = user_secret
         if account_id is not None:
             _path_params["accountId"] = account_id
-        if brokerage_order_id is not None:
-            _path_params["brokerageOrderId"] = brokerage_order_id
         args.query = query_params if query_params else _query_params
         args.path = path_params if path_params else _path_params
         return args
 
     async def _aget_user_account_order_detail_oapg(
         self,
+        body: typing.Any = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         skip_deserialization: bool = True,
         timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
+        content_type: str = 'application/json',
         stream: bool = False,
         **kwargs,
     ) -> typing.Union[
@@ -231,7 +316,6 @@ class BaseApi(api_client.Api):
         _path_params = {}
         for parameter in (
             request_path_account_id,
-            request_path_brokerage_order_id,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -261,20 +345,36 @@ class BaseApi(api_client.Api):
         if accept_content_types:
             for accept_content_type in accept_content_types:
                 _headers.add('Accept', accept_content_type)
-        method = 'get'.upper()
+        method = 'post'.upper()
+        _headers.add('Content-Type', content_type)
+    
+        if body is schemas.unset:
+            raise exceptions.ApiValueError(
+                'The required body parameter has an invalid value of: unset. Set a valid value instead')
+        _fields = None
+        _body = None
         request_before_hook(
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/orders/{brokerageOrderId}',
+            path_template='/accounts/{accountId}/orders/details',
+            body=body,
             auth_settings=_auth,
             headers=_headers,
         )
+        serialized_data = request_body_typing_any.serialize(body, content_type)
+        if 'fields' in serialized_data:
+            _fields = serialized_data['fields']
+        elif 'body' in serialized_data:
+            _body = serialized_data['body']
     
         response = await self.api_client.async_call_api(
             resource_path=used_path,
             method=method,
             headers=_headers,
+            fields=_fields,
+            serialized_body=_body,
+            body=body,
             auth_settings=_auth,
             prefix_separator_iterator=prefix_separator_iterator,
             timeout=timeout,
@@ -337,11 +437,13 @@ class BaseApi(api_client.Api):
 
     def _get_user_account_order_detail_oapg(
         self,
+        body: typing.Any = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         skip_deserialization: bool = True,
         timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
+        content_type: str = 'application/json',
         stream: bool = False,
     ) -> typing.Union[
         ApiResponseFor200,
@@ -360,7 +462,6 @@ class BaseApi(api_client.Api):
         _path_params = {}
         for parameter in (
             request_path_account_id,
-            request_path_brokerage_order_id,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -390,20 +491,36 @@ class BaseApi(api_client.Api):
         if accept_content_types:
             for accept_content_type in accept_content_types:
                 _headers.add('Accept', accept_content_type)
-        method = 'get'.upper()
+        method = 'post'.upper()
+        _headers.add('Content-Type', content_type)
+    
+        if body is schemas.unset:
+            raise exceptions.ApiValueError(
+                'The required body parameter has an invalid value of: unset. Set a valid value instead')
+        _fields = None
+        _body = None
         request_before_hook(
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/orders/{brokerageOrderId}',
+            path_template='/accounts/{accountId}/orders/details',
+            body=body,
             auth_settings=_auth,
             headers=_headers,
         )
+        serialized_data = request_body_typing_any.serialize(body, content_type)
+        if 'fields' in serialized_data:
+            _fields = serialized_data['fields']
+        elif 'body' in serialized_data:
+            _body = serialized_data['body']
     
         response = self.api_client.call_api(
             resource_path=used_path,
             method=method,
             headers=_headers,
+            fields=_fields,
+            serialized_body=_body,
+            body=body,
             auth_settings=_auth,
             prefix_separator_iterator=prefix_separator_iterator,
             timeout=timeout,
@@ -438,10 +555,11 @@ class GetUserAccountOrderDetail(BaseApi):
 
     async def aget_user_account_order_detail(
         self,
+        body: typing.Optional[typing.Any] = None,
+        external_order_id: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
-        account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -451,14 +569,16 @@ class GetUserAccountOrderDetail(BaseApi):
         AsyncGeneratorResponse,
     ]:
         args = self._get_user_account_order_detail_mapped_args(
+            body=body,
             query_params=query_params,
             path_params=path_params,
+            external_order_id=external_order_id,
+            account_id=account_id,
             user_id=user_id,
             user_secret=user_secret,
-            account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
         )
         return await self._aget_user_account_order_detail_oapg(
+            body=args.body,
             query_params=args.query,
             path_params=args.path,
             **kwargs,
@@ -466,39 +586,43 @@ class GetUserAccountOrderDetail(BaseApi):
     
     def get_user_account_order_detail(
         self,
+        body: typing.Optional[typing.Any] = None,
+        external_order_id: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
-        account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.  """
+        """ 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.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.  """
         args = self._get_user_account_order_detail_mapped_args(
+            body=body,
             query_params=query_params,
             path_params=path_params,
+            external_order_id=external_order_id,
+            account_id=account_id,
             user_id=user_id,
             user_secret=user_secret,
-            account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
         )
         return self._get_user_account_order_detail_oapg(
+            body=args.body,
             query_params=args.query,
             path_params=args.path,
         )
 
-class ApiForget(BaseApi):
+class ApiForpost(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
-    async def aget(
+    async def apost(
         self,
+        body: typing.Optional[typing.Any] = None,
+        external_order_id: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
-        account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -508,41 +632,46 @@ class ApiForget(BaseApi):
         AsyncGeneratorResponse,
     ]:
         args = self._get_user_account_order_detail_mapped_args(
+            body=body,
             query_params=query_params,
             path_params=path_params,
+            external_order_id=external_order_id,
+            account_id=account_id,
             user_id=user_id,
             user_secret=user_secret,
-            account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
         )
         return await self._aget_user_account_order_detail_oapg(
+            body=args.body,
             query_params=args.query,
             path_params=args.path,
             **kwargs,
         )
     
-    def get(
+    def post(
         self,
+        body: typing.Optional[typing.Any] = None,
+        external_order_id: typing.Optional[str] = None,
+        account_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
-        account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.  """
+        """ 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.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.  """
         args = self._get_user_account_order_detail_mapped_args(
+            body=body,
             query_params=query_params,
             path_params=path_params,
+            external_order_id=external_order_id,
+            account_id=account_id,
             user_id=user_id,
             user_secret=user_secret,
-            account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
         )
         return self._get_user_account_order_detail_oapg(
+            body=args.body,
             query_params=args.query,
             path_params=args.path,
         )

snaptrade_client/paths/{accounts_account_id_orders_brokerage_order_id → brokerages_slug_instruments}/__init__.py

@@ -1,7 +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_brokerage_order_id import Api
+# from snaptrade_client.paths.brokerages_slug_instruments import Api
 
 from snaptrade_client.paths import PathValues
 
-path = PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID
+path = PathValues.BROKERAGES_SLUG_INSTRUMENTS

snaptrade_client/paths/{brokerages_brokerage_id_instruments → brokerages_slug_instruments}/get.py

@@ -39,11 +39,11 @@ from snaptrade_client.type.brokerage_instruments_response import BrokerageInstru
 from . import path
 
 # Path params
-BrokerageIdSchema = schemas.UUIDSchema
+SlugSchema = schemas.StrSchema
 RequestRequiredPathParams = typing_extensions.TypedDict(
     'RequestRequiredPathParams',
     {
-        'brokerageId': typing.Union[BrokerageIdSchema, str, uuid.UUID, ],
+        'slug': typing.Union[SlugSchema, str, ],
     }
 )
 RequestOptionalPathParams = typing_extensions.TypedDict(
@@ -58,10 +58,10 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams):
     pass
 
 
-request_path_brokerage_id = api_client.PathParameter(
-    name="brokerageId",
+request_path_slug = api_client.PathParameter(
+    name="slug",
     style=api_client.ParameterStyle.SIMPLE,
-    schema=BrokerageIdSchema,
+    schema=SlugSchema,
     required=True,
 )
 _auth = [
@@ -118,13 +118,13 @@ class BaseApi(api_client.Api):
 
     def _list_all_brokerage_instruments_mapped_args(
         self,
-        brokerage_id: typing.Optional[str] = None,
+        slug: typing.Optional[str] = None,
         path_params: typing.Optional[dict] = {},
     ) -> api_client.MappedArgs:
         args: api_client.MappedArgs = api_client.MappedArgs()
         _path_params = {}
-        if brokerage_id is not None:
-            _path_params["brokerageId"] = brokerage_id
+        if slug is not None:
+            _path_params["slug"] = slug
         args.path = path_params if path_params else _path_params
         return args
 
@@ -153,7 +153,7 @@ class BaseApi(api_client.Api):
     
         _path_params = {}
         for parameter in (
-            request_path_brokerage_id,
+            request_path_slug,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -174,7 +174,7 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/brokerages/{brokerageId}/instruments',
+            path_template='/brokerages/{slug}/instruments',
             auth_settings=_auth,
             headers=_headers,
         )
@@ -270,7 +270,7 @@ class BaseApi(api_client.Api):
     
         _path_params = {}
         for parameter in (
-            request_path_brokerage_id,
+            request_path_slug,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -291,7 +291,7 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/brokerages/{brokerageId}/instruments',
+            path_template='/brokerages/{slug}/instruments',
             auth_settings=_auth,
             headers=_headers,
         )
@@ -338,7 +338,7 @@ class ListAllBrokerageInstruments(BaseApi):
 
     async def alist_all_brokerage_instruments(
         self,
-        brokerage_id: typing.Optional[str] = None,
+        slug: typing.Optional[str] = None,
         path_params: typing.Optional[dict] = {},
         **kwargs,
     ) -> typing.Union[
@@ -349,7 +349,7 @@ class ListAllBrokerageInstruments(BaseApi):
     ]:
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
-            brokerage_id=brokerage_id,
+            slug=slug,
         )
         return await self._alist_all_brokerage_instruments_oapg(
             path_params=args.path,
@@ -358,7 +358,7 @@ class ListAllBrokerageInstruments(BaseApi):
     
     def list_all_brokerage_instruments(
         self,
-        brokerage_id: typing.Optional[str] = None,
+        slug: typing.Optional[str] = None,
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
@@ -368,7 +368,7 @@ class ListAllBrokerageInstruments(BaseApi):
         """ Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. """
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
-            brokerage_id=brokerage_id,
+            slug=slug,
         )
         return self._list_all_brokerage_instruments_oapg(
             path_params=args.path,
@@ -379,7 +379,7 @@ class ApiForget(BaseApi):
 
     async def aget(
         self,
-        brokerage_id: typing.Optional[str] = None,
+        slug: typing.Optional[str] = None,
         path_params: typing.Optional[dict] = {},
         **kwargs,
     ) -> typing.Union[
@@ -390,7 +390,7 @@ class ApiForget(BaseApi):
     ]:
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
-            brokerage_id=brokerage_id,
+            slug=slug,
         )
         return await self._alist_all_brokerage_instruments_oapg(
             path_params=args.path,
@@ -399,7 +399,7 @@ class ApiForget(BaseApi):
     
     def get(
         self,
-        brokerage_id: typing.Optional[str] = None,
+        slug: typing.Optional[str] = None,
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
@@ -409,7 +409,7 @@ class ApiForget(BaseApi):
         """ Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. """
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
-            brokerage_id=brokerage_id,
+            slug=slug,
         )
         return self._list_all_brokerage_instruments_oapg(
             path_params=args.path,