lusid-sdk 2.1.830__py3-none-any.whl → 2.1.831__py3-none-any.whl

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/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/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.7910\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

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/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/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

lusid/models/order_rule_breach.py

@@ -0,0 +1,79 @@
+# 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 typing import Any, Dict
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, constr, validator 
+
+class OrderRuleBreach(BaseModel):
+    """
+    OrderRuleBreach
+    """
+    breach_task_id:  StrictStr = Field(...,alias="breachTaskId", description="Uniquely identifies this historical order breach workflow task.") 
+    compliance_state:  StrictStr = Field(...,alias="complianceState", description="The compliance state of this order breach. Possible values are 'Pending', 'Failed', 'Manually approved', 'Passed' and 'Warning'.") 
+    __properties = ["breachTaskId", "complianceState"]
+
+    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) -> OrderRuleBreach:
+        """Create an instance of OrderRuleBreach 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)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> OrderRuleBreach:
+        """Create an instance of OrderRuleBreach from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return OrderRuleBreach.parse_obj(obj)
+
+        _obj = OrderRuleBreach.parse_obj({
+            "breach_task_id": obj.get("breachTaskId"),
+            "compliance_state": obj.get("complianceState")
+        })
+        return _obj

lusid/models/paged_resource_list_of_order_breach_history.py

@@ -0,0 +1,121 @@
+# 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 typing import Any, Dict, List, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictStr, conlist 
+from lusid.models.link import Link
+from lusid.models.order_breach_history import OrderBreachHistory
+
+class PagedResourceListOfOrderBreachHistory(BaseModel):
+    """
+    PagedResourceListOfOrderBreachHistory
+    """
+    next_page:  Optional[StrictStr] = Field(None,alias="nextPage") 
+    previous_page:  Optional[StrictStr] = Field(None,alias="previousPage") 
+    values: conlist(OrderBreachHistory) = Field(...)
+    href:  Optional[StrictStr] = Field(None,alias="href") 
+    links: Optional[conlist(Link)] = None
+    __properties = ["nextPage", "previousPage", "values", "href", "links"]
+
+    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) -> PagedResourceListOfOrderBreachHistory:
+        """Create an instance of PagedResourceListOfOrderBreachHistory 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 each item in values (list)
+        _items = []
+        if self.values:
+            for _item in self.values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['values'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if next_page (nullable) is None
+        # and __fields_set__ contains the field
+        if self.next_page is None and "next_page" in self.__fields_set__:
+            _dict['nextPage'] = None
+
+        # set to None if previous_page (nullable) is None
+        # and __fields_set__ contains the field
+        if self.previous_page is None and "previous_page" in self.__fields_set__:
+            _dict['previousPage'] = None
+
+        # set to None if href (nullable) is None
+        # and __fields_set__ contains the field
+        if self.href is None and "href" in self.__fields_set__:
+            _dict['href'] = None
+
+        # set to None if links (nullable) is None
+        # and __fields_set__ contains the field
+        if self.links is None and "links" in self.__fields_set__:
+            _dict['links'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PagedResourceListOfOrderBreachHistory:
+        """Create an instance of PagedResourceListOfOrderBreachHistory from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PagedResourceListOfOrderBreachHistory.parse_obj(obj)
+
+        _obj = PagedResourceListOfOrderBreachHistory.parse_obj({
+            "next_page": obj.get("nextPage"),
+            "previous_page": obj.get("previousPage"),
+            "values": [OrderBreachHistory.from_dict(_item) for _item in obj.get("values")] if obj.get("values") is not None else None,
+            "href": obj.get("href"),
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj

{lusid_sdk-2.1.830.dist-info → lusid_sdk-2.1.831.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.830
+Version: 2.1.831
 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.dist-info → lusid_sdk-2.1.831.dist-info}/RECORD

@@ -1,4 +1,4 @@
-lusid/__init__.py,sha256=Zl5vUrcQYtRiFQu6nPEZC_ffOSaIcf_bQmbVEyyojVc,138816
+lusid/__init__.py,sha256=LYGlEVx6i8rhVt3j70bk7GHAmE6prlGzx4JlxseqJK4,139141
 lusid/api/__init__.py,sha256=rDMCQ5xxj5K43PAE4v9joIu4G8XxM2QNi2Dj0vFQA8A,6471
 lusid/api/abor_api.py,sha256=N7Wsh0395mXOvpJI8z0Nrx5OY4nCP5FN9RkbtdHaZbM,165987
 lusid/api/abor_configuration_api.py,sha256=xQ9HcXm02eDFhCdWUHjqFRWl1oQMxm2LNObJ9kcLauU,84216
@@ -12,7 +12,7 @@ lusid/api/blocks_api.py,sha256=WvkS7tK4jY1R_SWV8FqjCr5zpF9Gx1basp62FBdyH_E,43230
 lusid/api/calendars_api.py,sha256=Z1Zo2PDggpII8e6DyKlun1EZkCqU0I9MtqTsKfu5buI,141755
 lusid/api/chart_of_accounts_api.py,sha256=cyLfNKPJpBuy61U1HqVGNh1bmwAoTDpaIGQ1SeuMU-I,404270
 lusid/api/complex_market_data_api.py,sha256=qxhtgdCS0oIctX3T6V90wk7FiTeB_Hubu_yRTUPyGwg,67034
-lusid/api/compliance_api.py,sha256=mbq3E4h6nMQp7mowJussYN2f92YDIsjwYQw7wiTjHG4,147595
+lusid/api/compliance_api.py,sha256=zVn3TuZ97PqKKh-b666fHgs3mfVcDD9nELX7zTTsdz0,161480
 lusid/api/configuration_recipe_api.py,sha256=1hdNB1imRjVzf8KAmqnNJE10jv883s1SCza5dl8fP9Q,99363
 lusid/api/conventions_api.py,sha256=dsvB_lAcR5oVQLTqVJj9_zruF7Tyn8aGzD9EmEKvfWY,104288
 lusid/api/corporate_action_sources_api.py,sha256=7Js9dAFi_HOsYjZvYQew8SjK8x45x-Bi3VJxY-dhDKU,98350
@@ -77,7 +77,7 @@ lusid/api/translation_api.py,sha256=xpRuTfwQvYBlWe6r_L2EI_uVpXqHFnEOim-i-kVQ85E,
 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=hOh-IE7iuG6kh3faFoZLNCR8AgfBTkjmVPm7fcrkT0A,17972
+lusid/configuration.py,sha256=hIbLxOiz0VxCiYQuRQD1oKgD9BqaiMYvhsh_KbuBBuk,17972
 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
@@ -92,7 +92,7 @@ lusid/extensions/rest.py,sha256=dp-bD_LMR2zAL1tmC3-urhWKLomXx7r5iGN1VteMBVQ,1601
 lusid/extensions/retry.py,sha256=EhW9OKJmGHipxN3H7eROH5DiMlAnfBVl95NQrttcsdg,14834
 lusid/extensions/socket_keep_alive.py,sha256=eX5ICvGfVzUCGIm80Q2RknfFZrBQAdnrcpY61M29V_k,1997
 lusid/extensions/tcp_keep_alive_connector.py,sha256=zaGtUsygRsxB1_4B3x39K3ILwztdhMLDv5bFZV7zmGE,3877
-lusid/models/__init__.py,sha256=XqU2D6NjtOxyjcvlBMJ_KgKgjQZWvdzwfFgNgfvBC5Q,131313
+lusid/models/__init__.py,sha256=pV5JvdKUkEOTZL7bflYAHdjWjrYJaGvviGudQYUorqc,131638
 lusid/models/a2_b_breakdown.py,sha256=-FXgILrvtZXQDmvS0ARaJVGBq5LJ4AH-o3HjujFVmS4,3198
 lusid/models/a2_b_category.py,sha256=WunXUgx-dCnApPeLC8Qo5tVCX8Ywxkehib1vmNqNgNs,2957
 lusid/models/a2_b_data_record.py,sha256=qANTmV1_HUEo4l72-F8qzZjlQxOe0Onc9WPz7h-WWuY,9993
@@ -364,7 +364,7 @@ lusid/models/custodian_account.py,sha256=eT17O-_F69CVKRGeoil12WW_9XpSeF6lIJcJ_1r
 lusid/models/custodian_account_properties.py,sha256=1OWHeXZB4tINkDm1-tQsHiiaxK6Q8q0Jb9a3lBTyScs,4610
 lusid/models/custodian_account_request.py,sha256=ejBV8XPgHE_SijJWKfu6qpSHRXl83AM4GTGbnW3zZFM,5889
 lusid/models/custodian_accounts_upsert_response.py,sha256=JifiqVoKIwK73PUtx1nMR9e9JH9NiTdnUEaklPAgW_I,4629
-lusid/models/custom_data_model.py,sha256=A6sd_p6eT5c8ceOwdg-UqdCkfFN8EcpEdY-PQ00zwUQ,3676
+lusid/models/custom_data_model.py,sha256=CBfqbvkLVR28Q5mG2GWIIm_cHQIj4moZ8rX3wczV25I,4037
 lusid/models/custom_data_model_criteria.py,sha256=873vt--Yak9_SFcr7LpLBuj8HyJoYXFH-0EHB_SSHwE,6699
 lusid/models/custom_data_model_identifier_type_specification.py,sha256=OmS062q5I172iV3vOcei9jJPIu_kFdHopaF6MW8OLy8,2596
 lusid/models/custom_data_model_identifier_type_specification_with_display_name.py,sha256=kosgFBwpz6ZcKmQu3iP4Z-hpvIRhe2gnnamFWXj5F1k,3585
@@ -729,6 +729,7 @@ lusid/models/option_exercise_election.py,sha256=n6rxh81aPTSSXQPZ62IMO4NmSaDZbXpn
 lusid/models/option_exercise_physical_event.py,sha256=Xh2Pv56ewCvjCgzPygL_gKb58R0U2wD0hI4FyyRJU7Q,15874
 lusid/models/optionality_schedule.py,sha256=6UAJJyujoLY8b4ujDXMpu-V9WFVyKI-l7inKdmofIqw,8759
 lusid/models/order.py,sha256=KrLbhRbUKb-JE4yvG3UTZ6RWBZTXCjyjYsPmqKJg-1c,9892
+lusid/models/order_breach_history.py,sha256=1G-1ieqx_4ksW4MjQmU9op9abqRyKvfbWcpJL50N4RU,4511
 lusid/models/order_by_spec.py,sha256=q-vo1gZt9JhjNeRXez-hfpHV1JMjK6OGf6TKi4wfR9U,5578
 lusid/models/order_flow_configuration.py,sha256=7iWxrL8fryDbcXrKytM6rzB0xmkCOm3F6-dKoACEBA0,2482
 lusid/models/order_graph_block.py,sha256=XNHaVjeamkLgKKNgOvDuJ8qaKPujgC3xsiA1681mHnM,5495
@@ -755,6 +756,7 @@ lusid/models/order_instruction.py,sha256=lZHFAJlUK9H_slQO6uILrGPZ9RCMUFqLi3zam7N
 lusid/models/order_instruction_request.py,sha256=CYvDG505wPlD5a9tdjkCS1q6L9I1yhQScq8gr-buH_U,5741
 lusid/models/order_instruction_set_request.py,sha256=HFlDichvpwgPsPZj6awIo6ofn066RP1rosX7kgUQ7FI,2996
 lusid/models/order_request.py,sha256=vA90s8q8Y58x--4KpJJ6O5fWtoauOBBhusMdpherXDA,8088
+lusid/models/order_rule_breach.py,sha256=FFEoFnUVuL-fcVjfokHKvMDOaSa--of5qN7wYj0B31E,2486
 lusid/models/order_set_request.py,sha256=b7FHKZWawLGR83gRHpShjtdYxvlvyMdLhQGLi2HTjmQ,2948
 lusid/models/order_update_request.py,sha256=eXPD9g6f-W5C42JGpNyOijrnPO7jmYERWNgXMfu46VU,5371
 lusid/models/otc_confirmation.py,sha256=05mvXvcPLgyCNIHXN7g9L5nqAZORKrQA_wHW-fHe2O0,2651
@@ -803,6 +805,7 @@ lusid/models/paged_resource_list_of_instrument_event_instruction.py,sha256=j7vW0
 lusid/models/paged_resource_list_of_item_and_workspace.py,sha256=3tb3XW-kvPvu15o-YiDPRonZv2ptfeUisWJmIMCiWX4,4424
 lusid/models/paged_resource_list_of_legal_entity.py,sha256=kc__KlK_idJw8g0be1HUtCbEFo-l3OH1ZH5Abmp6JJo,4363
 lusid/models/paged_resource_list_of_order.py,sha256=fNxwZBrLsNnp1fVcvbrNxh7zeKtybdgfC0hFfxaRePI,4290
+lusid/models/paged_resource_list_of_order_breach_history.py,sha256=a6YHr8Q_ifjQ77wEKGSwA7609RSS-XNBUIrDRC9Aza4,4448
 lusid/models/paged_resource_list_of_order_graph_block.py,sha256=69pMcdJ21oPEl80Nev5PfVZ_jCewGXbJKgAn58Ji7a8,4412
 lusid/models/paged_resource_list_of_order_graph_placement.py,sha256=axEjiRs6iYi_PYrNTWIfexn9Aj5SGbKnvkWqrHkgCOE,4460
 lusid/models/paged_resource_list_of_order_instruction.py,sha256=HHbiTxZ94xTeKhlFTmRMdyWsYBTwexWyXPTuLQW1Kjs,4423
@@ -1323,6 +1326,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.830.dist-info/METADATA,sha256=HNkpOlmZa07xpLnuQibojWTYgzdzGFg63MfzA7X676c,221539
-lusid_sdk-2.1.830.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-lusid_sdk-2.1.830.dist-info/RECORD,,
+lusid_sdk-2.1.831.dist-info/METADATA,sha256=wNe6lAGzL5SBRTiAu8XsOFf9nLmuve8O59xRusR_wa0,221939
+lusid_sdk-2.1.831.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+lusid_sdk-2.1.831.dist-info/RECORD,,