lusid-sdk 2.1.960__py3-none-any.whl → 2.1.961__py3-none-any.whl

lusid/api/transaction_portfolios_api.py

@@ -1062,22 +1062,22 @@ class TransactionPortfoliosApi:
 
 
     @overload
-    async def build_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the settlement instructions. Defaults to return the latest              version of each transaction if not specified.")] = None, **kwargs) -> VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery:  # noqa: E501
+    async def build_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], **kwargs) -> VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery:  # noqa: E501
         ...
 
     @overload
-    def build_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the settlement instructions. Defaults to return the latest              version of each transaction if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery:  # noqa: E501
+    def build_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery:  # noqa: E501
         ...
 
     @validate_arguments
-    def build_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the settlement instructions. Defaults to return the latest              version of each transaction if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery, Awaitable[VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery]]:  # noqa: E501
+    def build_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery, Awaitable[VersionedResourceListWithPostBodiesOfSettlementInstructionWithTransactionToSettlementInstructionQuery]]:  # noqa: E501
         """[EARLY ACCESS] BuildSettlementInstructions: Build Settlement Instructions  # noqa: E501
 
         Builds and returns all settlement instructions that have been loaded against this portfolio.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.build_settlement_instructions(scope, code, settlement_instruction_query, as_at, async_req=True)
+        >>> thread = api.build_settlement_instructions(scope, code, settlement_instruction_query, async_req=True)
         >>> result = thread.get()
 
         :param scope: The scope of the transaction portfolio. (required)
@@ -1086,8 +1086,6 @@ class TransactionPortfoliosApi:
         :type code: str
         :param settlement_instruction_query: The queryParameters which control how the settlement instructions are built and returned. (required)
         :type settlement_instruction_query: SettlementInstructionQuery
-        :param as_at: The asAt datetime at which to build the settlement instructions. Defaults to return the latest              version of each transaction if not specified.
-        :type as_at: datetime
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
@@ -1104,17 +1102,17 @@ class TransactionPortfoliosApi:
             raise ValueError(message)
         if async_req is not None:
             kwargs['async_req'] = async_req
-        return self.build_settlement_instructions_with_http_info(scope, code, settlement_instruction_query, as_at, **kwargs)  # noqa: E501
+        return self.build_settlement_instructions_with_http_info(scope, code, settlement_instruction_query, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def build_settlement_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the settlement instructions. Defaults to return the latest              version of each transaction if not specified.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def build_settlement_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], settlement_instruction_query : Annotated[SettlementInstructionQuery, Field(..., description="The queryParameters which control how the settlement instructions are built and returned.")], **kwargs) -> ApiResponse:  # noqa: E501
         """[EARLY ACCESS] BuildSettlementInstructions: Build Settlement Instructions  # noqa: E501
 
         Builds and returns all settlement instructions that have been loaded against this portfolio.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.build_settlement_instructions_with_http_info(scope, code, settlement_instruction_query, as_at, async_req=True)
+        >>> thread = api.build_settlement_instructions_with_http_info(scope, code, settlement_instruction_query, async_req=True)
         >>> result = thread.get()
 
         :param scope: The scope of the transaction portfolio. (required)
@@ -1123,8 +1121,6 @@ class TransactionPortfoliosApi:
         :type code: str
         :param settlement_instruction_query: The queryParameters which control how the settlement instructions are built and returned. (required)
         :type settlement_instruction_query: SettlementInstructionQuery
-        :param as_at: The asAt datetime at which to build the settlement instructions. Defaults to return the latest              version of each transaction if not specified.
-        :type as_at: datetime
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -1154,8 +1150,7 @@ class TransactionPortfoliosApi:
         _all_params = [
             'scope',
             'code',
-            'settlement_instruction_query',
-            'as_at'
+            'settlement_instruction_query'
         ]
         _all_params.extend(
             [
@@ -1193,12 +1188,6 @@ class TransactionPortfoliosApi:
 
         # process the query parameters
         _query_params = []
-        if _params.get('as_at') is not None:  # noqa: E501
-            if isinstance(_params['as_at'], datetime):
-                _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
-            else:
-                _query_params.append(('asAt', _params['as_at']))
-
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters

lusid/configuration.py

@@ -445,7 +445,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.8307\n"\
+               "Version of the API: 0.11.8312\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

lusid/models/settlement_configuration_category.py

@@ -19,14 +19,16 @@ import json
 
 
 from typing import Any, Dict, Optional
-from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictStr 
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictBool, StrictStr 
 
 class SettlementConfigurationCategory(BaseModel):
     """
     SettlementConfigurationCategory
     """
     method:  Optional[StrictStr] = Field(None,alias="method", description="The method of settlement for the movements of the relevant type(s). Allowed values: 'Automatic' and 'Instructed'. A value of 'Instructed' means that such movements can only be settled with a SettlementInstruction. A value of 'Automatic' means that such movements will settle automatically but a SettlementInstruction will still override automatic settlement.") 
-    __properties = ["method"]
+    calculate_instruction_to_portfolio_rate: Optional[StrictBool] = Field(None, alias="calculateInstructionToPortfolioRate", description="An optional flag that allows for the calculation of the instruction to portfolio rate for instructions with settlement category CashSettlement or DeferredCashReceipt, if it is not provided on the settlement instruction. Defaults to false if not specified.")
+    calculate_in_lieu_settlement_amount: Optional[StrictBool] = Field(None, alias="calculateInLieuSettlementAmount", description="An optional flag that allows for the calculation of the in lieu amount for instructions with settlement category CashSettlement or DeferredCashReceipt, if it is not provided on the settlement instruction. Defaults to false if not specified.")
+    __properties = ["method", "calculateInstructionToPortfolioRate", "calculateInLieuSettlementAmount"]
 
     class Config:
         """Pydantic configuration"""
@@ -77,6 +79,8 @@ class SettlementConfigurationCategory(BaseModel):
             return SettlementConfigurationCategory.parse_obj(obj)
 
         _obj = SettlementConfigurationCategory.parse_obj({
-            "method": obj.get("method")
+            "method": obj.get("method"),
+            "calculate_instruction_to_portfolio_rate": obj.get("calculateInstructionToPortfolioRate"),
+            "calculate_in_lieu_settlement_amount": obj.get("calculateInLieuSettlementAmount")
         })
         return _obj

lusid/models/settlement_instruction_query.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from datetime import datetime
 from typing import Any, Dict, List, Optional
 from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictInt, StrictStr, conlist, constr, validator 
 
@@ -25,6 +25,7 @@ class SettlementInstructionQuery(BaseModel):
     """
     SettlementInstructionQuery
     """
+    as_at: Optional[datetime] = Field(None, alias="asAt")
     start_date:  Optional[StrictStr] = Field(None,alias="startDate") 
     end_date:  Optional[StrictStr] = Field(None,alias="endDate") 
     limit: Optional[StrictInt] = None
@@ -32,7 +33,7 @@ class SettlementInstructionQuery(BaseModel):
     filter:  Optional[StrictStr] = Field(None,alias="filter") 
     settlement_instruction_property_keys: Optional[conlist(StrictStr)] = Field(None, alias="settlementInstructionPropertyKeys")
     transaction_property_keys: Optional[conlist(StrictStr)] = Field(None, alias="transactionPropertyKeys")
-    __properties = ["startDate", "endDate", "limit", "page", "filter", "settlementInstructionPropertyKeys", "transactionPropertyKeys"]
+    __properties = ["asAt", "startDate", "endDate", "limit", "page", "filter", "settlementInstructionPropertyKeys", "transactionPropertyKeys"]
 
     class Config:
         """Pydantic configuration"""
@@ -66,6 +67,11 @@ class SettlementInstructionQuery(BaseModel):
                           exclude={
                           },
                           exclude_none=True)
+        # set to None if as_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.as_at is None and "as_at" in self.__fields_set__:
+            _dict['asAt'] = None
+
         # set to None if start_date (nullable) is None
         # and __fields_set__ contains the field
         if self.start_date is None and "start_date" in self.__fields_set__:
@@ -113,6 +119,7 @@ class SettlementInstructionQuery(BaseModel):
             return SettlementInstructionQuery.parse_obj(obj)
 
         _obj = SettlementInstructionQuery.parse_obj({
+            "as_at": obj.get("asAt"),
             "start_date": obj.get("startDate"),
             "end_date": obj.get("endDate"),
             "limit": obj.get("limit"),

{lusid_sdk-2.1.960.dist-info → lusid_sdk-2.1.961.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.960
+Version: 2.1.961
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT

{lusid_sdk-2.1.960.dist-info → lusid_sdk-2.1.961.dist-info}/RECORD

@@ -74,13 +74,13 @@ lusid/api/tax_rule_sets_api.py,sha256=ia8zjTdwlgLGC8KDWFBT21agOrfWgn1zC_ik75mNDJ
 lusid/api/timelines_api.py,sha256=uxSMdLi9dI6y8LSaezsLXEVedy9I7A-k22RAKY0Rw4k,109878
 lusid/api/transaction_configuration_api.py,sha256=VKzr-F1WWtMXK1MuyiiE7reWJZrBUQs655cIgX8CGC0,122096
 lusid/api/transaction_fees_api.py,sha256=r8Gl44-WYZebyJ_Uw2stLsf3-hPi1bK6Ij64Kx0L6A8,62698
-lusid/api/transaction_portfolios_api.py,sha256=srNruQmJVOwT4mSVIdUtbr2DI1UzgnaMyWVAL20Pvzg,686538
+lusid/api/transaction_portfolios_api.py,sha256=yNMout-bkFgo0MmPiFIwHLBsD8gWLpMRZHq1gqxoIK4,684877
 lusid/api/transfer_agency_api.py,sha256=m-o3srFi7ZcUcWlO_lpOJiYZJvDSt2JLy7QPcXQoPh4,9545
 lusid/api/translation_api.py,sha256=xpRuTfwQvYBlWe6r_L2EI_uVpXqHFnEOim-i-kVQ85E,20227
 lusid/api/workspace_api.py,sha256=0pCNi3ZCRbIo0NXKa85XE7vtq0WV5YOKcQKvFlcLUaY,120708
 lusid/api_client.py,sha256=ewMTmf9SRurY8pYnUx9jy24RdldPCOa4US38pnrVxjA,31140
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=a0ElIVyv7WnYuUjz0p3ACgM230CiODjlD3c1iv7ttcA,17980
+lusid/configuration.py,sha256=VmL0tYZdLPhHQnrMEKLKLd5K2pNnOsiVGbhOmdMsUTA,17980
 lusid/exceptions.py,sha256=HIQwgmQrszLlcVCLaqex8dO0laVuejUyOMz7U2ZWJ6s,5326
 lusid/extensions/__init__.py,sha256=dzDHEzpn-9smd2-_UMWQzeyX6Ha4jGf6fnqx7qxKxNI,630
 lusid/extensions/api_client.py,sha256=GzygWg_h603QK1QS2HvAijuE2R1TnvoF6-Yg0CeM3ug,30943
@@ -1134,9 +1134,9 @@ lusid/models/set_person_properties_request.py,sha256=Pndq3BtayCATb-fmzUeFwSQtXaY
 lusid/models/set_share_class_instruments_request.py,sha256=wIxDkYoiimlHGioINv-bA63_rEs2W7pgNzGi8lbkoQs,3302
 lusid/models/set_transaction_configuration_alias.py,sha256=HXqUSsfc9BpUxDqQsWuCulekcHFFKlAZPT_sVxK5Mqc,2791
 lusid/models/set_transaction_configuration_source_request.py,sha256=onioX-Oi4zG91Cs0weO0oqRpdiD-BQgHLzYRlEmmr0I,4458
-lusid/models/settlement_configuration_category.py,sha256=Bmy5aesdk7MEpxgk5KyRVY0l9pB92iEtyYCdPZAcOos,2797
+lusid/models/settlement_configuration_category.py,sha256=s0El9li3Eu9144-UPcMbSgWWVlfVBb82323mjDq4_r8,3850
 lusid/models/settlement_cycle.py,sha256=0L4GedRTJ9kTTmIzwGo9EeMhQwbuPG8TfgMHpCVBAtk,2746
-lusid/models/settlement_instruction_query.py,sha256=f8_KzCqQJ9Phz6vb7wL9MOSHTnNQ6WXnu-DPZ5Y5r7U,4763
+lusid/models/settlement_instruction_query.py,sha256=GytEixNGDlOnrQQTSNEABN-9gFhKbaN_175zDxiaqcA,5094
 lusid/models/settlement_instruction_request.py,sha256=wvNv1H6co_Bo2-lDexy5YHVjncwdQADZY9eZDhUQiMQ,6324
 lusid/models/settlement_instruction_with_transaction.py,sha256=EW6nji9o1Qbgrhu01ixKn9-MypVgmm9tGqMuAmpT87U,3348
 lusid/models/settlement_schedule.py,sha256=QXjKoZyNHBjL0wM69Nw8O0iLBYyD8_S2aSyxYaStiiU,3910
@@ -1391,6 +1391,6 @@ lusid/models/year_month_day.py,sha256=gwSoxFwlD_wffKdddo1wfvAcLq3Cht3FHQidiaHzAA
 lusid/models/yield_curve_data.py,sha256=I1ZSWxHMgUxj9OQt6i9a4S91KB4_XtmrfFxpN_PV3YQ,9561
 lusid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lusid/rest.py,sha256=HQT__5LQEMu6_1sLKvYj-DI4FH1DJXBIPYfZCTTyrY4,13431
-lusid_sdk-2.1.960.dist-info/METADATA,sha256=Y1k_bN34taCBMRfCIr_Blbw5cWDfQXGTMGQJZE2z98E,233609
-lusid_sdk-2.1.960.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-lusid_sdk-2.1.960.dist-info/RECORD,,
+lusid_sdk-2.1.961.dist-info/METADATA,sha256=wCMgk8obHLNyzUFmPK3UpAzAplhGCe1R12hIVbKpoVU,233609
+lusid_sdk-2.1.961.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+lusid_sdk-2.1.961.dist-info/RECORD,,