lusid-sdk 2.1.788__py3-none-any.whl → 2.1.789__py3-none-any.whl

lusid/api/order_management_api.py

@@ -43,6 +43,8 @@ from lusid.models.resource_list_of_block_and_orders import ResourceListOfBlockAn
 from lusid.models.resource_list_of_change_interval_with_order_management_detail import ResourceListOfChangeIntervalWithOrderManagementDetail
 from lusid.models.resource_list_of_moved_order_to_different_block_response import ResourceListOfMovedOrderToDifferentBlockResponse
 from lusid.models.resource_list_of_placement import ResourceListOfPlacement
+from lusid.models.sweep_blocks_request import SweepBlocksRequest
+from lusid.models.sweep_blocks_response import SweepBlocksResponse
 from lusid.models.update_orders_response import UpdateOrdersResponse
 from lusid.models.update_placements_response import UpdatePlacementsResponse
 
@@ -1548,6 +1550,165 @@ class OrderManagementApi:
             _request_auth=_params.get('_request_auth'))
 
 
+    @overload
+    async def sweep_blocks(self, sweep_blocks_request : SweepBlocksRequest, **kwargs) -> SweepBlocksResponse:  # noqa: E501
+        ...
+
+    @overload
+    def sweep_blocks(self, sweep_blocks_request : SweepBlocksRequest, async_req: Optional[bool]=True, **kwargs) -> SweepBlocksResponse:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def sweep_blocks(self, sweep_blocks_request : SweepBlocksRequest, async_req: Optional[bool]=None, **kwargs) -> Union[SweepBlocksResponse, Awaitable[SweepBlocksResponse]]:  # noqa: E501
+        """[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful.  # noqa: E501
+
+        The requirements are:  <list type=\"bullet\"><term>The block exists.</term><term>All orders have state \"Closed\", \"Cancelled\", \"Canceled\" or \"Booked\".</term><term>All placements have state \"Allocated\" or \"Over-allocated\".</term><term>All allocations have state \"Closed\", \"Cancelled\", \"Canceled\" or \"Booked\".</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.sweep_blocks(sweep_blocks_request, async_req=True)
+        >>> result = thread.get()
+
+        :param sweep_blocks_request: (required)
+        :type sweep_blocks_request: SweepBlocksRequest
+        :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: SweepBlocksResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the sweep_blocks_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.sweep_blocks_with_http_info(sweep_blocks_request, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def sweep_blocks_with_http_info(self, sweep_blocks_request : SweepBlocksRequest, **kwargs) -> ApiResponse:  # noqa: E501
+        """[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful.  # noqa: E501
+
+        The requirements are:  <list type=\"bullet\"><term>The block exists.</term><term>All orders have state \"Closed\", \"Cancelled\", \"Canceled\" or \"Booked\".</term><term>All placements have state \"Allocated\" or \"Over-allocated\".</term><term>All allocations have state \"Closed\", \"Cancelled\", \"Canceled\" or \"Booked\".</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.sweep_blocks_with_http_info(sweep_blocks_request, async_req=True)
+        >>> result = thread.get()
+
+        :param sweep_blocks_request: (required)
+        :type sweep_blocks_request: SweepBlocksRequest
+        :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(SweepBlocksResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'sweep_blocks_request'
+        ]
+        _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 sweep_blocks" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        if _params['sweep_blocks_request'] is not None:
+            _body_params = _params['sweep_blocks_request']
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # set the HTTP header `Content-Type`
+        _content_types_list = _params.get('_content_type',
+            self.api_client.select_header_content_type(
+                ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
+        if _content_types_list:
+                _header_params['Content-Type'] = _content_types_list
+
+        # authentication setting
+        _auth_settings = ['oauth2']  # noqa: E501
+
+        _response_types_map = {
+            '200': "SweepBlocksResponse",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/ordermanagement/SweepBlocks', 'POST',
+            _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 update_orders(self, request_body : Annotated[Dict[str, OrderUpdateRequest], Field(..., description="The request containing the orders to be updated.")], **kwargs) -> UpdateOrdersResponse:  # 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.7763\n"\
+               "Version of the API: 0.11.7769\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

lusid/models/__init__.py

@@ -944,6 +944,7 @@ from lusid.models.resource_list_of_quote_access_metadata_rule import ResourceLis
 from lusid.models.resource_list_of_reconciliation_break import ResourceListOfReconciliationBreak
 from lusid.models.resource_list_of_relation import ResourceListOfRelation
 from lusid.models.resource_list_of_relationship import ResourceListOfRelationship
+from lusid.models.resource_list_of_returns_entity import ResourceListOfReturnsEntity
 from lusid.models.resource_list_of_scope_definition import ResourceListOfScopeDefinition
 from lusid.models.resource_list_of_side_definition import ResourceListOfSideDefinition
 from lusid.models.resource_list_of_string import ResourceListOfString
@@ -967,6 +968,7 @@ from lusid.models.result_value_int import ResultValueInt
 from lusid.models.result_value_string import ResultValueString
 from lusid.models.result_value_type import ResultValueType
 from lusid.models.return_zero_pv_options import ReturnZeroPvOptions
+from lusid.models.returns_entity import ReturnsEntity
 from lusid.models.reverse_stock_split_event import ReverseStockSplitEvent
 from lusid.models.rollover_constituent import RolloverConstituent
 from lusid.models.rounding_configuration import RoundingConfiguration
@@ -1034,6 +1036,8 @@ from lusid.models.structured_result_data_id import StructuredResultDataId
 from lusid.models.sub_holding_key_value_equals import SubHoldingKeyValueEquals
 from lusid.models.swap_cash_flow_event import SwapCashFlowEvent
 from lusid.models.swap_principal_event import SwapPrincipalEvent
+from lusid.models.sweep_blocks_request import SweepBlocksRequest
+from lusid.models.sweep_blocks_response import SweepBlocksResponse
 from lusid.models.target_tax_lot import TargetTaxLot
 from lusid.models.target_tax_lot_request import TargetTaxLotRequest
 from lusid.models.tax_rule import TaxRule
@@ -2160,6 +2164,7 @@ __all__ = [
     "ResourceListOfReconciliationBreak",
     "ResourceListOfRelation",
     "ResourceListOfRelationship",
+    "ResourceListOfReturnsEntity",
     "ResourceListOfScopeDefinition",
     "ResourceListOfSideDefinition",
     "ResourceListOfString",
@@ -2183,6 +2188,7 @@ __all__ = [
     "ResultValueString",
     "ResultValueType",
     "ReturnZeroPvOptions",
+    "ReturnsEntity",
     "ReverseStockSplitEvent",
     "RolloverConstituent",
     "RoundingConfiguration",
@@ -2250,6 +2256,8 @@ __all__ = [
     "SubHoldingKeyValueEquals",
     "SwapCashFlowEvent",
     "SwapPrincipalEvent",
+    "SweepBlocksRequest",
+    "SweepBlocksResponse",
     "TargetTaxLot",
     "TargetTaxLotRequest",
     "TaxRule",

lusid/models/resource_list_of_returns_entity.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.returns_entity import ReturnsEntity
+
+class ResourceListOfReturnsEntity(BaseModel):
+    """
+    ResourceListOfReturnsEntity
+    """
+    values: conlist(ReturnsEntity) = Field(...)
+    href:  Optional[StrictStr] = Field(None,alias="href") 
+    links: Optional[conlist(Link)] = None
+    next_page:  Optional[StrictStr] = Field(None,alias="nextPage") 
+    previous_page:  Optional[StrictStr] = Field(None,alias="previousPage") 
+    __properties = ["values", "href", "links", "nextPage", "previousPage"]
+
+    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) -> ResourceListOfReturnsEntity:
+        """Create an instance of ResourceListOfReturnsEntity 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 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
+
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ResourceListOfReturnsEntity:
+        """Create an instance of ResourceListOfReturnsEntity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ResourceListOfReturnsEntity.parse_obj(obj)
+
+        _obj = ResourceListOfReturnsEntity.parse_obj({
+            "values": [ReturnsEntity.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,
+            "next_page": obj.get("nextPage"),
+            "previous_page": obj.get("previousPage")
+        })
+        return _obj

lusid/models/returns_entity.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, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictStr, constr 
+from lusid.models.resource_id import ResourceId
+
+class ReturnsEntity(BaseModel):
+    """
+    Returns entity, used for configuring the calculation of aggregated returns.  # noqa: E501
+    """
+    id: ResourceId = Field(...)
+    recipe_id: Optional[ResourceId] = Field(None, alias="recipeId")
+    recipe_entity:  Optional[StrictStr] = Field(None,alias="recipeEntity", description="Entity a recipe is retrieved from for use in the aggregated returns calculation. Either RecipeId or RecipeEntity must be specified.") 
+    fee_handling:  Optional[StrictStr] = Field(None,alias="feeHandling", description="Configures how fees are handled in the aggregated returns calculation.") 
+    flow_handling:  Optional[StrictStr] = Field(None,alias="flowHandling", description="Configures how flows are handled in the aggregated returns calculation.") 
+    business_calendar:  Optional[StrictStr] = Field(None,alias="businessCalendar", description="Calendar used in the aggregated returns calculation.") 
+    handle_flow_discrepancy:  Optional[StrictStr] = Field(None,alias="handleFlowDiscrepancy", description="Configures handling for the case where net flows do not match the sum of tagged flows.") 
+    __properties = ["id", "recipeId", "recipeEntity", "feeHandling", "flowHandling", "businessCalendar", "handleFlowDiscrepancy"]
+
+    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) -> ReturnsEntity:
+        """Create an instance of ReturnsEntity 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 recipe_id
+        if self.recipe_id:
+            _dict['recipeId'] = self.recipe_id.to_dict()
+        # set to None if recipe_entity (nullable) is None
+        # and __fields_set__ contains the field
+        if self.recipe_entity is None and "recipe_entity" in self.__fields_set__:
+            _dict['recipeEntity'] = None
+
+        # set to None if fee_handling (nullable) is None
+        # and __fields_set__ contains the field
+        if self.fee_handling is None and "fee_handling" in self.__fields_set__:
+            _dict['feeHandling'] = None
+
+        # set to None if flow_handling (nullable) is None
+        # and __fields_set__ contains the field
+        if self.flow_handling is None and "flow_handling" in self.__fields_set__:
+            _dict['flowHandling'] = None
+
+        # set to None if business_calendar (nullable) is None
+        # and __fields_set__ contains the field
+        if self.business_calendar is None and "business_calendar" in self.__fields_set__:
+            _dict['businessCalendar'] = None
+
+        # set to None if handle_flow_discrepancy (nullable) is None
+        # and __fields_set__ contains the field
+        if self.handle_flow_discrepancy is None and "handle_flow_discrepancy" in self.__fields_set__:
+            _dict['handleFlowDiscrepancy'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReturnsEntity:
+        """Create an instance of ReturnsEntity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReturnsEntity.parse_obj(obj)
+
+        _obj = ReturnsEntity.parse_obj({
+            "id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
+            "recipe_id": ResourceId.from_dict(obj.get("recipeId")) if obj.get("recipeId") is not None else None,
+            "recipe_entity": obj.get("recipeEntity"),
+            "fee_handling": obj.get("feeHandling"),
+            "flow_handling": obj.get("flowHandling"),
+            "business_calendar": obj.get("businessCalendar"),
+            "handle_flow_discrepancy": obj.get("handleFlowDiscrepancy")
+        })
+        return _obj

lusid/models/sweep_blocks_request.py

@@ -0,0 +1,92 @@
+# 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 
+from lusid.models.resource_id import ResourceId
+
+class SweepBlocksRequest(BaseModel):
+    """
+    A request to sweep specified blocks.  # noqa: E501
+    """
+    block_ids: Dict[str, ResourceId] = Field(..., alias="blockIds", description="A dictionary mapping ephemeral identifiers, which live as long as the request, to specific blocks to sweep.")
+    latest_allowable_modification_time:  StrictStr = Field(...,alias="latestAllowableModificationTime", description="Timestamp or cut label which the  block or related entities must not have been updated after.") 
+    __properties = ["blockIds", "latestAllowableModificationTime"]
+
+    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) -> SweepBlocksRequest:
+        """Create an instance of SweepBlocksRequest 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 value in block_ids (dict)
+        _field_dict = {}
+        if self.block_ids:
+            for _key in self.block_ids:
+                if self.block_ids[_key]:
+                    _field_dict[_key] = self.block_ids[_key].to_dict()
+            _dict['blockIds'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> SweepBlocksRequest:
+        """Create an instance of SweepBlocksRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return SweepBlocksRequest.parse_obj(obj)
+
+        _obj = SweepBlocksRequest.parse_obj({
+            "block_ids": dict(
+                (_k, ResourceId.from_dict(_v))
+                for _k, _v in obj.get("blockIds").items()
+            )
+            if obj.get("blockIds") is not None
+            else None,
+            "latest_allowable_modification_time": obj.get("latestAllowableModificationTime")
+        })
+        return _obj