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

snaptrade_client/paths/activities/get.pyi

@@ -7,15 +7,17 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from dataclasses import dataclass
 import typing_extensions
 import urllib3
+from snaptrade_client.request_before_hook import request_before_hook
 import json
 from urllib3._collections import HTTPHeaderDict
 
+from snaptrade_client.api_response import AsyncGeneratorResponse
 from snaptrade_client import api_client, exceptions
 from datetime import date, datetime  # noqa: F401
 import decimal  # noqa: F401
@@ -30,13 +32,16 @@ import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
 
-from snaptrade_client.model.universal_activity import UniversalActivity
+from snaptrade_client.model.universal_activity import UniversalActivity as UniversalActivitySchema
+
+from snaptrade_client.type.universal_activity import UniversalActivity
 
 # Query params
 StartDateSchema = schemas.DateSchema
 EndDateSchema = schemas.DateSchema
 AccountsSchema = schemas.StrSchema
 BrokerageAuthorizationsSchema = schemas.StrSchema
+TypeSchema = schemas.StrSchema
 UserIdSchema = schemas.StrSchema
 UserSecretSchema = schemas.StrSchema
 RequestRequiredQueryParams = typing_extensions.TypedDict(
@@ -53,6 +58,7 @@ RequestOptionalQueryParams = typing_extensions.TypedDict(
         'endDate': typing.Union[EndDateSchema, str, date, ],
         'accounts': typing.Union[AccountsSchema, str, ],
         'brokerageAuthorizations': typing.Union[BrokerageAuthorizationsSchema, str, ],
+        'type': typing.Union[TypeSchema, str, ],
     },
     total=False
 )
@@ -86,6 +92,12 @@ request_query_brokerage_authorizations = api_client.QueryParameter(
     schema=BrokerageAuthorizationsSchema,
     explode=True,
 )
+request_query_type = api_client.QueryParameter(
+    name="type",
+    style=api_client.ParameterStyle.FORM,
+    schema=TypeSchema,
+    explode=True,
+)
 request_query_user_id = api_client.QueryParameter(
     name="userId",
     style=api_client.ParameterStyle.FORM,
@@ -110,8 +122,8 @@ class SchemaFor200ResponseBodyApplicationJson(
     class MetaOapg:
         
         @staticmethod
-        def items() -> typing.Type['UniversalActivity']:
-            return UniversalActivity
+        def items() -> typing.Type['UniversalActivitySchema']:
+            return UniversalActivitySchema
 
     def __new__(
         cls,
@@ -130,13 +142,17 @@ class SchemaFor200ResponseBodyApplicationJson(
 
 @dataclass
 class ApiResponseFor200(api_client.ApiResponse):
-    body: typing.Union[
-        SchemaFor200ResponseBodyApplicationJson,
-    ]
+    body: typing.List[UniversalActivity]
+
+
+@dataclass
+class ApiResponseFor200Async(api_client.AsyncApiResponse):
+    body: typing.List[UniversalActivity]
 
 
 _response_for_200 = api_client.OpenApiResponse(
     response_cls=ApiResponseFor200,
+    response_cls_async=ApiResponseFor200Async,
     content={
         'application/json': api_client.MediaType(
             schema=SchemaFor200ResponseBodyApplicationJson),
@@ -149,6 +165,11 @@ class ApiResponseForDefault(api_client.ApiResponse):
     body: schemas.Unset = schemas.unset
 
 
+@dataclass
+class ApiResponseForDefaultAsync(api_client.AsyncApiResponse):
+    body: schemas.Unset = schemas.unset
+
+
 _response_for_default = api_client.OpenApiResponse(
     response_cls=ApiResponseForDefault,
 )
@@ -159,12 +180,169 @@ _all_accept_content_types = (
 
 class BaseApi(api_client.Api):
 
+    def _get_activities_mapped_args(
+        self,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        start_date: typing.Optional[date] = None,
+        end_date: typing.Optional[date] = None,
+        accounts: typing.Optional[str] = None,
+        brokerage_authorizations: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        query_params: typing.Optional[dict] = {},
+    ) -> api_client.MappedArgs:
+        args: api_client.MappedArgs = api_client.MappedArgs()
+        _query_params = {}
+        if start_date is not None:
+            _query_params["startDate"] = start_date
+        if end_date is not None:
+            _query_params["endDate"] = end_date
+        if accounts is not None:
+            _query_params["accounts"] = accounts
+        if brokerage_authorizations is not None:
+            _query_params["brokerageAuthorizations"] = brokerage_authorizations
+        if type is not None:
+            _query_params["type"] = type
+        if user_id is not None:
+            _query_params["userId"] = user_id
+        if user_secret is not None:
+            _query_params["userSecret"] = user_secret
+        args.query = query_params if query_params else _query_params
+        return args
+
+    async def _aget_activities_oapg(
+        self,
+        query_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,
+        stream: bool = False,
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        ApiResponseForDefaultAsync,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        """
+        Get transaction history for a user
+        :param skip_deserialization: If true then api_response.response will be set but
+            api_response.body and api_response.headers will not be deserialized into schema
+            class instances
+        """
+        self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params)
+        used_path = path.value
+    
+        prefix_separator_iterator = None
+        for parameter in (
+            request_query_start_date,
+            request_query_end_date,
+            request_query_accounts,
+            request_query_brokerage_authorizations,
+            request_query_type,
+            request_query_user_id,
+            request_query_user_secret,
+        ):
+            parameter_data = query_params.get(parameter.name, schemas.unset)
+            if parameter_data is schemas.unset:
+                continue
+            if prefix_separator_iterator is None:
+                prefix_separator_iterator = parameter.get_prefix_separator_iterator()
+            serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator)
+            for serialized_value in serialized_data.values():
+                used_path += serialized_value
+    
+        _headers = HTTPHeaderDict()
+        # TODO add cookie handling
+        if accept_content_types:
+            for accept_content_type in accept_content_types:
+                _headers.add('Accept', accept_content_type)
+        method = 'get'.upper()
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/activities',
+            auth_settings=_auth,
+            headers=_headers,
+        )
+    
+        response = await self.api_client.async_call_api(
+            resource_path=used_path,
+            method=method,
+            headers=_headers,
+            auth_settings=_auth,
+            prefix_separator_iterator=prefix_separator_iterator,
+            timeout=timeout,
+            **kwargs
+        )
+    
+        if stream:
+            if not 200 <= response.http_response.status <= 299:
+                body = (await response.http_response.content.read()).decode("utf-8")
+                raise exceptions.ApiStreamingException(
+                    status=response.http_response.status,
+                    reason=response.http_response.reason,
+                    body=body,
+                )
+    
+            async def stream_iterator():
+                """
+                iterates over response.http_response.content and closes connection once iteration has finished
+                """
+                async for line in response.http_response.content:
+                    if line == b'\r\n':
+                        continue
+                    yield line
+                response.http_response.close()
+                await response.session.close()
+            return AsyncGeneratorResponse(
+                content=stream_iterator(),
+                headers=response.http_response.headers,
+                status=response.http_response.status,
+                response=response.http_response
+            )
+    
+        response_for_status = _status_code_to_response.get(str(response.http_response.status))
+        if response_for_status:
+            api_response = await response_for_status.deserialize_async(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+        else:
+            default_response = _status_code_to_response.get('default')
+            if default_response:
+                api_response = default_response.deserialize(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+            else:
+                api_response = api_client.ApiResponseWithoutDeserializationAsync(
+                    response=response.http_response,
+                    round_trip_time=response.round_trip_time,
+                    status=response.http_response.status,
+                    headers=response.http_response.headers,
+                )
+    
+        if not 200 <= api_response.status <= 299:
+            raise exceptions.ApiException(api_response=api_response)
+    
+        # cleanup session / response
+        response.http_response.close()
+        await response.session.close()
+    
+        return api_response
+
+
     def _get_activities_oapg(
         self,
+        query_params: typing.Optional[dict] = {},
         skip_deserialization: bool = True,
-        timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
+        timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
+        stream: bool = False,
     ) -> typing.Union[
         ApiResponseFor200,
         ApiResponseForDefault,
@@ -178,13 +356,14 @@ class BaseApi(api_client.Api):
         """
         self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params)
         used_path = path.value
-
+    
         prefix_separator_iterator = None
         for parameter in (
             request_query_start_date,
             request_query_end_date,
             request_query_accounts,
             request_query_brokerage_authorizations,
+            request_query_type,
             request_query_user_id,
             request_query_user_secret,
         ):
@@ -196,29 +375,38 @@ class BaseApi(api_client.Api):
             serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator)
             for serialized_value in serialized_data.values():
                 used_path += serialized_value
-
+    
         _headers = HTTPHeaderDict()
         # TODO add cookie handling
         if accept_content_types:
             for accept_content_type in accept_content_types:
                 _headers.add('Accept', accept_content_type)
-
+        method = 'get'.upper()
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/activities',
+            auth_settings=_auth,
+            headers=_headers,
+        )
+    
         response = self.api_client.call_api(
             resource_path=used_path,
-            method='get'.upper(),
+            method=method,
             headers=_headers,
             auth_settings=_auth,
             prefix_separator_iterator=prefix_separator_iterator,
             timeout=timeout,
         )
-
+    
         response_for_status = _status_code_to_response.get(str(response.http_response.status))
         if response_for_status:
             api_response = response_for_status.deserialize(
-                                                   response,
-                                                   self.api_client.configuration,
-                                                   skip_deserialization=skip_deserialization
-                                               )
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
         else:
             default_response = _status_code_to_response.get('default')
             if default_response:
@@ -234,78 +422,144 @@ class BaseApi(api_client.Api):
                     status=response.http_response.status,
                     headers=response.http_response.headers,
                 )
-
+    
         if not 200 <= api_response.status <= 299:
             raise exceptions.ApiException(api_response=api_response)
-
+    
         return api_response
 
 
 class GetActivities(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
+    @api_client.DeprecationWarningOnce(prefix="transactions_and_reporting")
+    async def aget_activities(
+        self,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        start_date: typing.Optional[date] = None,
+        end_date: typing.Optional[date] = None,
+        accounts: typing.Optional[str] = None,
+        brokerage_authorizations: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        query_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        ApiResponseForDefaultAsync,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._get_activities_mapped_args(
+            query_params=query_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            start_date=start_date,
+            end_date=end_date,
+            accounts=accounts,
+            brokerage_authorizations=brokerage_authorizations,
+            type=type,
+        )
+        return await self._aget_activities_oapg(
+            query_params=args.query,
+            **kwargs,
+        )
+    
+    @api_client.DeprecationWarningOnce(prefix="transactions_and_reporting")
     def get_activities(
         self,
-        user_id: typing.Any = None,
-        user_secret: typing.Any = None,
-        start_date: typing.Any = None,
-        end_date: typing.Any = None,
-        accounts: typing.Any = None,
-        brokerage_authorizations: typing.Any = None,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        start_date: typing.Optional[date] = None,
+        end_date: typing.Optional[date] = None,
+        accounts: typing.Optional[str] = None,
+        brokerage_authorizations: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        query_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        if start_date is not None:
-            query_params["startDate"] = start_date
-        if end_date is not None:
-            query_params["endDate"] = end_date
-        if accounts is not None:
-            query_params["accounts"] = accounts
-        if brokerage_authorizations is not None:
-            query_params["brokerageAuthorizations"] = brokerage_authorizations
-        if user_id is not None:
-            query_params["userId"] = user_id
-        if user_secret is not None:
-            query_params["userSecret"] = user_secret
-        return self._get_activities_oapg(
+        """ This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible  Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.  """
+        args = self._get_activities_mapped_args(
             query_params=query_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            start_date=start_date,
+            end_date=end_date,
+            accounts=accounts,
+            brokerage_authorizations=brokerage_authorizations,
+            type=type,
+        )
+        return self._get_activities_oapg(
+            query_params=args.query,
         )
-
 
 class ApiForget(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
+    @api_client.DeprecationWarningOnce(prefix="transactions_and_reporting")
+    async def aget(
+        self,
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        start_date: typing.Optional[date] = None,
+        end_date: typing.Optional[date] = None,
+        accounts: typing.Optional[str] = None,
+        brokerage_authorizations: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        query_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        ApiResponseForDefaultAsync,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._get_activities_mapped_args(
+            query_params=query_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            start_date=start_date,
+            end_date=end_date,
+            accounts=accounts,
+            brokerage_authorizations=brokerage_authorizations,
+            type=type,
+        )
+        return await self._aget_activities_oapg(
+            query_params=args.query,
+            **kwargs,
+        )
+    
+    @api_client.DeprecationWarningOnce(prefix="transactions_and_reporting")
     def get(
         self,
-        user_id: typing.Any = None,
-        user_secret: typing.Any = None,
-        start_date: typing.Any = None,
-        end_date: typing.Any = None,
-        accounts: typing.Any = None,
-        brokerage_authorizations: typing.Any = None,
-        query_params: typing.Union[RequestQueryParams, dict] = {},
+        user_id: typing.Optional[str] = None,
+        user_secret: typing.Optional[str] = None,
+        start_date: typing.Optional[date] = None,
+        end_date: typing.Optional[date] = None,
+        accounts: typing.Optional[str] = None,
+        brokerage_authorizations: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        query_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        if start_date is not None:
-            query_params["startDate"] = start_date
-        if end_date is not None:
-            query_params["endDate"] = end_date
-        if accounts is not None:
-            query_params["accounts"] = accounts
-        if brokerage_authorizations is not None:
-            query_params["brokerageAuthorizations"] = brokerage_authorizations
-        if user_id is not None:
-            query_params["userId"] = user_id
-        if user_secret is not None:
-            query_params["userSecret"] = user_secret
-        return self._get_activities_oapg(
+        """ This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible  Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.  """
+        args = self._get_activities_mapped_args(
             query_params=query_params,
+            user_id=user_id,
+            user_secret=user_secret,
+            start_date=start_date,
+            end_date=end_date,
+            accounts=accounts,
+            brokerage_authorizations=brokerage_authorizations,
+            type=type,
+        )
+        return self._get_activities_oapg(
+            query_params=args.query,
         )
-