lusid-sdk 2.1.830__tar.gz → 2.1.832__tar.gz

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.830
+Version: 2.1.832
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -144,6 +144,7 @@ Class | Method | HTTP request | Description
 *ComplianceApi* | [**list_compliance_rules**](docs/ComplianceApi.md#list_compliance_rules) | **GET** /api/compliance/rules | [EARLY ACCESS] ListComplianceRules: List compliance rules.
 *ComplianceApi* | [**list_compliance_runs**](docs/ComplianceApi.md#list_compliance_runs) | **GET** /api/compliance/runs | [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
 *ComplianceApi* | [**list_compliance_templates**](docs/ComplianceApi.md#list_compliance_templates) | **GET** /api/compliance/templates | [EARLY ACCESS] ListComplianceTemplates: List compliance templates.
+*ComplianceApi* | [**list_order_breach_history**](docs/ComplianceApi.md#list_order_breach_history) | **GET** /api/compliance/runs/breaches | [EXPERIMENTAL] ListOrderBreachHistory: List Historical Order Breaches.
 *ComplianceApi* | [**run_compliance**](docs/ComplianceApi.md#run_compliance) | **POST** /api/compliance/runs | [EARLY ACCESS] RunCompliance: Run a compliance check.
 *ComplianceApi* | [**run_compliance_preview**](docs/ComplianceApi.md#run_compliance_preview) | **POST** /api/compliance/preview/runs | [EARLY ACCESS] RunCompliancePreview: Run a compliance check.
 *ComplianceApi* | [**update_compliance_template**](docs/ComplianceApi.md#update_compliance_template) | **PUT** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate
@@ -1299,6 +1300,7 @@ Class | Method | HTTP request | Description
  - [OptionExercisePhysicalEvent](docs/OptionExercisePhysicalEvent.md)
  - [OptionalitySchedule](docs/OptionalitySchedule.md)
  - [Order](docs/Order.md)
+ - [OrderBreachHistory](docs/OrderBreachHistory.md)
  - [OrderBySpec](docs/OrderBySpec.md)
  - [OrderFlowConfiguration](docs/OrderFlowConfiguration.md)
  - [OrderGraphBlock](docs/OrderGraphBlock.md)
@@ -1325,6 +1327,7 @@ Class | Method | HTTP request | Description
  - [OrderInstructionRequest](docs/OrderInstructionRequest.md)
  - [OrderInstructionSetRequest](docs/OrderInstructionSetRequest.md)
  - [OrderRequest](docs/OrderRequest.md)
+ - [OrderRuleBreach](docs/OrderRuleBreach.md)
  - [OrderSetRequest](docs/OrderSetRequest.md)
  - [OrderUpdateRequest](docs/OrderUpdateRequest.md)
  - [OtcConfirmation](docs/OtcConfirmation.md)
@@ -1373,6 +1376,7 @@ Class | Method | HTTP request | Description
  - [PagedResourceListOfItemAndWorkspace](docs/PagedResourceListOfItemAndWorkspace.md)
  - [PagedResourceListOfLegalEntity](docs/PagedResourceListOfLegalEntity.md)
  - [PagedResourceListOfOrder](docs/PagedResourceListOfOrder.md)
+ - [PagedResourceListOfOrderBreachHistory](docs/PagedResourceListOfOrderBreachHistory.md)
  - [PagedResourceListOfOrderGraphBlock](docs/PagedResourceListOfOrderGraphBlock.md)
  - [PagedResourceListOfOrderGraphPlacement](docs/PagedResourceListOfOrderGraphPlacement.md)
  - [PagedResourceListOfOrderInstruction](docs/PagedResourceListOfOrderInstruction.md)

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/README.md

@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
 *ComplianceApi* | [**list_compliance_rules**](docs/ComplianceApi.md#list_compliance_rules) | **GET** /api/compliance/rules | [EARLY ACCESS] ListComplianceRules: List compliance rules.
 *ComplianceApi* | [**list_compliance_runs**](docs/ComplianceApi.md#list_compliance_runs) | **GET** /api/compliance/runs | [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
 *ComplianceApi* | [**list_compliance_templates**](docs/ComplianceApi.md#list_compliance_templates) | **GET** /api/compliance/templates | [EARLY ACCESS] ListComplianceTemplates: List compliance templates.
+*ComplianceApi* | [**list_order_breach_history**](docs/ComplianceApi.md#list_order_breach_history) | **GET** /api/compliance/runs/breaches | [EXPERIMENTAL] ListOrderBreachHistory: List Historical Order Breaches.
 *ComplianceApi* | [**run_compliance**](docs/ComplianceApi.md#run_compliance) | **POST** /api/compliance/runs | [EARLY ACCESS] RunCompliance: Run a compliance check.
 *ComplianceApi* | [**run_compliance_preview**](docs/ComplianceApi.md#run_compliance_preview) | **POST** /api/compliance/preview/runs | [EARLY ACCESS] RunCompliancePreview: Run a compliance check.
 *ComplianceApi* | [**update_compliance_template**](docs/ComplianceApi.md#update_compliance_template) | **PUT** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate
@@ -1272,6 +1273,7 @@ Class | Method | HTTP request | Description
  - [OptionExercisePhysicalEvent](docs/OptionExercisePhysicalEvent.md)
  - [OptionalitySchedule](docs/OptionalitySchedule.md)
  - [Order](docs/Order.md)
+ - [OrderBreachHistory](docs/OrderBreachHistory.md)
  - [OrderBySpec](docs/OrderBySpec.md)
  - [OrderFlowConfiguration](docs/OrderFlowConfiguration.md)
  - [OrderGraphBlock](docs/OrderGraphBlock.md)
@@ -1298,6 +1300,7 @@ Class | Method | HTTP request | Description
  - [OrderInstructionRequest](docs/OrderInstructionRequest.md)
  - [OrderInstructionSetRequest](docs/OrderInstructionSetRequest.md)
  - [OrderRequest](docs/OrderRequest.md)
+ - [OrderRuleBreach](docs/OrderRuleBreach.md)
  - [OrderSetRequest](docs/OrderSetRequest.md)
  - [OrderUpdateRequest](docs/OrderUpdateRequest.md)
  - [OtcConfirmation](docs/OtcConfirmation.md)
@@ -1346,6 +1349,7 @@ Class | Method | HTTP request | Description
  - [PagedResourceListOfItemAndWorkspace](docs/PagedResourceListOfItemAndWorkspace.md)
  - [PagedResourceListOfLegalEntity](docs/PagedResourceListOfLegalEntity.md)
  - [PagedResourceListOfOrder](docs/PagedResourceListOfOrder.md)
+ - [PagedResourceListOfOrderBreachHistory](docs/PagedResourceListOfOrderBreachHistory.md)
  - [PagedResourceListOfOrderGraphBlock](docs/PagedResourceListOfOrderGraphBlock.md)
  - [PagedResourceListOfOrderGraphPlacement](docs/PagedResourceListOfOrderGraphPlacement.md)
  - [PagedResourceListOfOrderInstruction](docs/PagedResourceListOfOrderInstruction.md)

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/lusid/__init__.py

@@ -738,6 +738,7 @@ from lusid.models.option_exercise_election import OptionExerciseElection
 from lusid.models.option_exercise_physical_event import OptionExercisePhysicalEvent
 from lusid.models.optionality_schedule import OptionalitySchedule
 from lusid.models.order import Order
+from lusid.models.order_breach_history import OrderBreachHistory
 from lusid.models.order_by_spec import OrderBySpec
 from lusid.models.order_flow_configuration import OrderFlowConfiguration
 from lusid.models.order_graph_block import OrderGraphBlock
@@ -764,6 +765,7 @@ from lusid.models.order_instruction import OrderInstruction
 from lusid.models.order_instruction_request import OrderInstructionRequest
 from lusid.models.order_instruction_set_request import OrderInstructionSetRequest
 from lusid.models.order_request import OrderRequest
+from lusid.models.order_rule_breach import OrderRuleBreach
 from lusid.models.order_set_request import OrderSetRequest
 from lusid.models.order_update_request import OrderUpdateRequest
 from lusid.models.otc_confirmation import OtcConfirmation
@@ -812,6 +814,7 @@ from lusid.models.paged_resource_list_of_instrument_event_instruction import Pag
 from lusid.models.paged_resource_list_of_item_and_workspace import PagedResourceListOfItemAndWorkspace
 from lusid.models.paged_resource_list_of_legal_entity import PagedResourceListOfLegalEntity
 from lusid.models.paged_resource_list_of_order import PagedResourceListOfOrder
+from lusid.models.paged_resource_list_of_order_breach_history import PagedResourceListOfOrderBreachHistory
 from lusid.models.paged_resource_list_of_order_graph_block import PagedResourceListOfOrderGraphBlock
 from lusid.models.paged_resource_list_of_order_graph_placement import PagedResourceListOfOrderGraphPlacement
 from lusid.models.paged_resource_list_of_order_instruction import PagedResourceListOfOrderInstruction
@@ -2056,6 +2059,7 @@ __all__ = [
     "OptionExercisePhysicalEvent",
     "OptionalitySchedule",
     "Order",
+    "OrderBreachHistory",
     "OrderBySpec",
     "OrderFlowConfiguration",
     "OrderGraphBlock",
@@ -2082,6 +2086,7 @@ __all__ = [
     "OrderInstructionRequest",
     "OrderInstructionSetRequest",
     "OrderRequest",
+    "OrderRuleBreach",
     "OrderSetRequest",
     "OrderUpdateRequest",
     "OtcConfirmation",
@@ -2130,6 +2135,7 @@ __all__ = [
     "PagedResourceListOfItemAndWorkspace",
     "PagedResourceListOfLegalEntity",
     "PagedResourceListOfOrder",
+    "PagedResourceListOfOrderBreachHistory",
     "PagedResourceListOfOrderGraphBlock",
     "PagedResourceListOfOrderGraphPlacement",
     "PagedResourceListOfOrderInstruction",

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/lusid/api/compliance_api.py

@@ -38,6 +38,7 @@ from lusid.models.deleted_entity_response import DeletedEntityResponse
 from lusid.models.paged_resource_list_of_compliance_rule_response import PagedResourceListOfComplianceRuleResponse
 from lusid.models.paged_resource_list_of_compliance_run_info_v2 import PagedResourceListOfComplianceRunInfoV2
 from lusid.models.paged_resource_list_of_compliance_template import PagedResourceListOfComplianceTemplate
+from lusid.models.paged_resource_list_of_order_breach_history import PagedResourceListOfOrderBreachHistory
 from lusid.models.update_compliance_template_request import UpdateComplianceTemplateRequest
 from lusid.models.upsert_compliance_rule_request import UpsertComplianceRuleRequest
 from lusid.models.upsert_compliance_run_summary_request import UpsertComplianceRunSummaryRequest
@@ -1798,6 +1799,194 @@ class ComplianceApi:
             _request_auth=_params.get('_request_auth'))
 
 
+    @overload
+    async def list_order_breach_history(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The time at which to get results from. Default : latest")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing historical order breaches from a previous call to list historical order breaches.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. A list of field names to sort by, each suffixed by \"ASC\" or \"DESC\"")] = None, **kwargs) -> PagedResourceListOfOrderBreachHistory:  # noqa: E501
+        ...
+
+    @overload
+    def list_order_breach_history(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The time at which to get results from. Default : latest")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing historical order breaches from a previous call to list historical order breaches.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. A list of field names to sort by, each suffixed by \"ASC\" or \"DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfOrderBreachHistory:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def list_order_breach_history(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The time at which to get results from. Default : latest")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing historical order breaches from a previous call to list historical order breaches.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. A list of field names to sort by, each suffixed by \"ASC\" or \"DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfOrderBreachHistory, Awaitable[PagedResourceListOfOrderBreachHistory]]:  # noqa: E501
+        """[EXPERIMENTAL] ListOrderBreachHistory: List Historical Order Breaches.  # noqa: E501
+
+        Lists Order Ids and Run Ids of prior compliance runs, with the breached Rules Ids specified, or a subset with a filter.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.list_order_breach_history(as_at, page, limit, filter, sort_by, async_req=True)
+        >>> result = thread.get()
+
+        :param as_at: Optional. The time at which to get results from. Default : latest
+        :type as_at: datetime
+        :param page: Optional. The pagination token to use to continue listing historical order breaches from a previous call to list historical order breaches.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields              must not have changed since the original request.
+        :type page: str
+        :param limit: Optional. When paginating, limit the number of returned results to this many.
+        :type limit: int
+        :param filter: Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
+        :type filter: str
+        :param sort_by: Optional. A list of field names to sort by, each suffixed by \"ASC\" or \"DESC\"
+        :type sort_by: List[str]
+        :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
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: PagedResourceListOfOrderBreachHistory
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the list_order_breach_history_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        if async_req is not None:
+            kwargs['async_req'] = async_req
+        return self.list_order_breach_history_with_http_info(as_at, page, limit, filter, sort_by, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def list_order_breach_history_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The time at which to get results from. Default : latest")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing historical order breaches from a previous call to list historical order breaches.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. A list of field names to sort by, each suffixed by \"ASC\" or \"DESC\"")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """[EXPERIMENTAL] ListOrderBreachHistory: List Historical Order Breaches.  # noqa: E501
+
+        Lists Order Ids and Run Ids of prior compliance runs, with the breached Rules Ids specified, or a subset with a filter.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.list_order_breach_history_with_http_info(as_at, page, limit, filter, sort_by, async_req=True)
+        >>> result = thread.get()
+
+        :param as_at: Optional. The time at which to get results from. Default : latest
+        :type as_at: datetime
+        :param page: Optional. The pagination token to use to continue listing historical order breaches from a previous call to list historical order breaches.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields              must not have changed since the original request.
+        :type page: str
+        :param limit: Optional. When paginating, limit the number of returned results to this many.
+        :type limit: int
+        :param filter: Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
+        :type filter: str
+        :param sort_by: Optional. A list of field names to sort by, each suffixed by \"ASC\" or \"DESC\"
+        :type sort_by: List[str]
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(PagedResourceListOfOrderBreachHistory, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'as_at',
+            'page',
+            'limit',
+            'filter',
+            'sort_by'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers',
+                'opts'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method list_order_breach_history" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # 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']))
+
+        if _params.get('page') is not None:  # noqa: E501
+            _query_params.append(('page', _params['page']))
+
+        if _params.get('limit') is not None:  # noqa: E501
+            _query_params.append(('limit', _params['limit']))
+
+        if _params.get('filter') is not None:  # noqa: E501
+            _query_params.append(('filter', _params['filter']))
+
+        if _params.get('sort_by') is not None:  # noqa: E501
+            _query_params.append(('sortBy', _params['sort_by']))
+            _collection_formats['sortBy'] = 'multi'
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['oauth2']  # noqa: E501
+
+        _response_types_map = {
+            '200': "PagedResourceListOfOrderBreachHistory",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/compliance/runs/breaches', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            opts=_params.get('opts'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
+
     @overload
     async def run_compliance(self, run_scope : Annotated[StrictStr, Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[StrictStr, Field(..., description="Required: Scope from which to select rules to be run.")], is_pre_trade : Annotated[StrictBool, Field(..., description="Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false")], recipe_id_scope : Annotated[StrictStr, Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[StrictStr, Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], **kwargs) -> ComplianceRunInfoV2:  # noqa: E501
         ...

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/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.7908\n"\
+               "Version of the API: 0.11.7911\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/lusid/models/__init__.py

@@ -650,6 +650,7 @@ from lusid.models.option_exercise_election import OptionExerciseElection
 from lusid.models.option_exercise_physical_event import OptionExercisePhysicalEvent
 from lusid.models.optionality_schedule import OptionalitySchedule
 from lusid.models.order import Order
+from lusid.models.order_breach_history import OrderBreachHistory
 from lusid.models.order_by_spec import OrderBySpec
 from lusid.models.order_flow_configuration import OrderFlowConfiguration
 from lusid.models.order_graph_block import OrderGraphBlock
@@ -676,6 +677,7 @@ from lusid.models.order_instruction import OrderInstruction
 from lusid.models.order_instruction_request import OrderInstructionRequest
 from lusid.models.order_instruction_set_request import OrderInstructionSetRequest
 from lusid.models.order_request import OrderRequest
+from lusid.models.order_rule_breach import OrderRuleBreach
 from lusid.models.order_set_request import OrderSetRequest
 from lusid.models.order_update_request import OrderUpdateRequest
 from lusid.models.otc_confirmation import OtcConfirmation
@@ -724,6 +726,7 @@ from lusid.models.paged_resource_list_of_instrument_event_instruction import Pag
 from lusid.models.paged_resource_list_of_item_and_workspace import PagedResourceListOfItemAndWorkspace
 from lusid.models.paged_resource_list_of_legal_entity import PagedResourceListOfLegalEntity
 from lusid.models.paged_resource_list_of_order import PagedResourceListOfOrder
+from lusid.models.paged_resource_list_of_order_breach_history import PagedResourceListOfOrderBreachHistory
 from lusid.models.paged_resource_list_of_order_graph_block import PagedResourceListOfOrderGraphBlock
 from lusid.models.paged_resource_list_of_order_graph_placement import PagedResourceListOfOrderGraphPlacement
 from lusid.models.paged_resource_list_of_order_instruction import PagedResourceListOfOrderInstruction
@@ -1881,6 +1884,7 @@ __all__ = [
     "OptionExercisePhysicalEvent",
     "OptionalitySchedule",
     "Order",
+    "OrderBreachHistory",
     "OrderBySpec",
     "OrderFlowConfiguration",
     "OrderGraphBlock",
@@ -1907,6 +1911,7 @@ __all__ = [
     "OrderInstructionRequest",
     "OrderInstructionSetRequest",
     "OrderRequest",
+    "OrderRuleBreach",
     "OrderSetRequest",
     "OrderUpdateRequest",
     "OtcConfirmation",
@@ -1955,6 +1960,7 @@ __all__ = [
     "PagedResourceListOfItemAndWorkspace",
     "PagedResourceListOfLegalEntity",
     "PagedResourceListOfOrder",
+    "PagedResourceListOfOrderBreachHistory",
     "PagedResourceListOfOrderGraphBlock",
     "PagedResourceListOfOrderGraphPlacement",
     "PagedResourceListOfOrderInstruction",

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/lusid/models/custom_data_model.py

@@ -22,6 +22,7 @@ from typing import Any, Dict, Optional
 from pydantic.v1 import StrictStr, Field, BaseModel, Field 
 from lusid.models.custom_data_model_criteria import CustomDataModelCriteria
 from lusid.models.data_model_summary import DataModelSummary
+from lusid.models.version import Version
 
 class CustomDataModel(BaseModel):
     """
@@ -31,7 +32,8 @@ class CustomDataModel(BaseModel):
     inherited: Optional[CustomDataModelCriteria] = None
     incremental: Optional[CustomDataModelCriteria] = None
     applied: Optional[CustomDataModelCriteria] = None
-    __properties = ["dataModelSummary", "inherited", "incremental", "applied"]
+    version: Optional[Version] = None
+    __properties = ["dataModelSummary", "inherited", "incremental", "applied", "version"]
 
     class Config:
         """Pydantic configuration"""
@@ -77,6 +79,9 @@ class CustomDataModel(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of applied
         if self.applied:
             _dict['applied'] = self.applied.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of version
+        if self.version:
+            _dict['version'] = self.version.to_dict()
         return _dict
 
     @classmethod
@@ -92,6 +97,7 @@ class CustomDataModel(BaseModel):
             "data_model_summary": DataModelSummary.from_dict(obj.get("dataModelSummary")) if obj.get("dataModelSummary") is not None else None,
             "inherited": CustomDataModelCriteria.from_dict(obj.get("inherited")) if obj.get("inherited") is not None else None,
             "incremental": CustomDataModelCriteria.from_dict(obj.get("incremental")) if obj.get("incremental") is not None else None,
-            "applied": CustomDataModelCriteria.from_dict(obj.get("applied")) if obj.get("applied") is not None else None
+            "applied": CustomDataModelCriteria.from_dict(obj.get("applied")) if obj.get("applied") is not None else None,
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None
         })
         return _obj

{lusid_sdk-2.1.830 → lusid_sdk-2.1.832}/lusid/models/loan_principal_repayment_event.py

@@ -30,10 +30,11 @@ class LoanPrincipalRepaymentEvent(InstrumentEvent):
     payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date that the Principal is due to be paid.")
     currency:  StrictStr = Field(...,alias="currency", description="Currency of the repayment.") 
     lapse_elections: Optional[conlist(LapseElection)] = Field(None, alias="lapseElections", description="Election for controlling whether the Principal is paid automatically or not.  Exactly one election must be provided.")
-    fraction: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Fraction of the principal balance to be repaid.  Must be between 0 and 1, inclusive.  Defaults to 1 if not set.")
+    fraction: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Fraction of the outstanding settled principal balance to be repaid. Must be between 0 and 1, inclusive.  Defaults to 1 if not set. Ignored if the field Amount is set to a value different than zero.  Note that if there is a repayment on an unsettled trade and the repayment is specified as a fraction,  this repayment will not be applied to the unsettled position, as the fraction is always applied to  the settled balance only.")
+    amount: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Amount to be repaid (independent of the fraction).  This field is not used at all if not set or set to 0, in this case the fraction field will be used instead.  Otherwise, the fraction field is ignored.")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent") 
     additional_properties: Dict[str, Any] = {}
-    __properties = ["instrumentEventType", "paymentDate", "currency", "lapseElections", "fraction"]
+    __properties = ["instrumentEventType", "paymentDate", "currency", "lapseElections", "fraction", "amount"]
 
     @validator('instrument_event_type')
     def instrument_event_type_validate_enum(cls, value):
@@ -144,6 +145,16 @@ class LoanPrincipalRepaymentEvent(InstrumentEvent):
         if self.lapse_elections is None and "lapse_elections" in self.__fields_set__:
             _dict['lapseElections'] = None
 
+        # set to None if fraction (nullable) is None
+        # and __fields_set__ contains the field
+        if self.fraction is None and "fraction" in self.__fields_set__:
+            _dict['fraction'] = None
+
+        # set to None if amount (nullable) is None
+        # and __fields_set__ contains the field
+        if self.amount is None and "amount" in self.__fields_set__:
+            _dict['amount'] = None
+
         return _dict
 
     @classmethod
@@ -160,7 +171,8 @@ class LoanPrincipalRepaymentEvent(InstrumentEvent):
             "payment_date": obj.get("paymentDate"),
             "currency": obj.get("currency"),
             "lapse_elections": [LapseElection.from_dict(_item) for _item in obj.get("lapseElections")] if obj.get("lapseElections") is not None else None,
-            "fraction": obj.get("fraction")
+            "fraction": obj.get("fraction"),
+            "amount": obj.get("amount")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

lusid_sdk-2.1.832/lusid/models/order_breach_history.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+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, conlist 
+from lusid.models.order_rule_breach import OrderRuleBreach
+from lusid.models.resource_id import ResourceId
+
+class OrderBreachHistory(BaseModel):
+    """
+    OrderBreachHistory
+    """
+    id: ResourceId = Field(...)
+    order_id: ResourceId = Field(..., alias="orderId")
+    run_id: ResourceId = Field(..., alias="runId")
+    breaches_by_rule: Optional[Dict[str, conlist(OrderRuleBreach)]] = Field(None, alias="breachesByRule", description="Compliance rule breaches associations with the order and run.")
+    as_at: datetime = Field(..., alias="asAt", description="The asAt datetime at which the order breach was created in LUSID.")
+    __properties = ["id", "orderId", "runId", "breachesByRule", "asAt"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> OrderBreachHistory:
+        """Create an instance of OrderBreachHistory from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of order_id
+        if self.order_id:
+            _dict['orderId'] = self.order_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of run_id
+        if self.run_id:
+            _dict['runId'] = self.run_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in breaches_by_rule (dict of array)
+        _field_dict_of_array = {}
+        if self.breaches_by_rule:
+            for _key in self.breaches_by_rule:
+                if self.breaches_by_rule[_key]:
+                    _field_dict_of_array[_key] = [
+                        _item.to_dict() for _item in self.breaches_by_rule[_key]
+                    ]
+            _dict['breachesByRule'] = _field_dict_of_array
+        # set to None if breaches_by_rule (nullable) is None
+        # and __fields_set__ contains the field
+        if self.breaches_by_rule is None and "breaches_by_rule" in self.__fields_set__:
+            _dict['breachesByRule'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> OrderBreachHistory:
+        """Create an instance of OrderBreachHistory from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return OrderBreachHistory.parse_obj(obj)
+
+        _obj = OrderBreachHistory.parse_obj({
+            "id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
+            "order_id": ResourceId.from_dict(obj.get("orderId")) if obj.get("orderId") is not None else None,
+            "run_id": ResourceId.from_dict(obj.get("runId")) if obj.get("runId") is not None else None,
+            "breaches_by_rule": dict(
+                (_k,
+                        [OrderRuleBreach.from_dict(_item) for _item in _v]
+                        if _v is not None
+                        else None
+                )
+                for _k, _v in obj.get("breachesByRule").items()
+            ),
+            "as_at": obj.get("asAt")
+        })
+        return _obj