lusid-sdk 2.1.979__tar.gz → 2.1.981__tar.gz

{lusid_sdk-2.1.979 → lusid_sdk-2.1.981}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.979
+Version: 2.1.981
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -493,6 +493,7 @@ Class | Method | HTTP request | Description
 *PropertyDefinitionsApi* | [**create_property_definition**](docs/PropertyDefinitionsApi.md#create_property_definition) | **POST** /api/propertydefinitions | CreatePropertyDefinition: Create property definition
 *PropertyDefinitionsApi* | [**delete_property_definition**](docs/PropertyDefinitionsApi.md#delete_property_definition) | **DELETE** /api/propertydefinitions/{domain}/{scope}/{code} | DeletePropertyDefinition: Delete property definition
 *PropertyDefinitionsApi* | [**delete_property_definition_properties**](docs/PropertyDefinitionsApi.md#delete_property_definition_properties) | **POST** /api/propertydefinitions/{domain}/{scope}/{code}/properties/$delete | [EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties
+*PropertyDefinitionsApi* | [**get_derived_formula_explanation**](docs/PropertyDefinitionsApi.md#get_derived_formula_explanation) | **GET** /api/propertydefinitions/derived/$formulaExplanation | [INTERNAL] GetDerivedFormulaExplanation: Get explanation of a derived property formula
 *PropertyDefinitionsApi* | [**get_multiple_property_definitions**](docs/PropertyDefinitionsApi.md#get_multiple_property_definitions) | **GET** /api/propertydefinitions | GetMultiplePropertyDefinitions: Get multiple property definitions
 *PropertyDefinitionsApi* | [**get_property_definition**](docs/PropertyDefinitionsApi.md#get_property_definition) | **GET** /api/propertydefinitions/{domain}/{scope}/{code} | GetPropertyDefinition: Get property definition
 *PropertyDefinitionsApi* | [**get_property_definition_property_time_series**](docs/PropertyDefinitionsApi.md#get_property_definition_property_time_series) | **GET** /api/propertydefinitions/{domain}/{scope}/{code}/properties/time-series | [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series
@@ -1031,6 +1032,8 @@ Class | Method | HTTP request | Description
  - [DependencySourceFilter](docs/DependencySourceFilter.md)
  - [DepositCloseEvent](docs/DepositCloseEvent.md)
  - [DepositInterestPaymentEvent](docs/DepositInterestPaymentEvent.md)
+ - [DerivationFormulaExplainRequest](docs/DerivationFormulaExplainRequest.md)
+ - [DerivedPropertyComponent](docs/DerivedPropertyComponent.md)
  - [DescribedAddressKey](docs/DescribedAddressKey.md)
  - [Dialect](docs/Dialect.md)
  - [DialectId](docs/DialectId.md)

{lusid_sdk-2.1.979 → lusid_sdk-2.1.981}/README.md

@@ -466,6 +466,7 @@ Class | Method | HTTP request | Description
 *PropertyDefinitionsApi* | [**create_property_definition**](docs/PropertyDefinitionsApi.md#create_property_definition) | **POST** /api/propertydefinitions | CreatePropertyDefinition: Create property definition
 *PropertyDefinitionsApi* | [**delete_property_definition**](docs/PropertyDefinitionsApi.md#delete_property_definition) | **DELETE** /api/propertydefinitions/{domain}/{scope}/{code} | DeletePropertyDefinition: Delete property definition
 *PropertyDefinitionsApi* | [**delete_property_definition_properties**](docs/PropertyDefinitionsApi.md#delete_property_definition_properties) | **POST** /api/propertydefinitions/{domain}/{scope}/{code}/properties/$delete | [EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties
+*PropertyDefinitionsApi* | [**get_derived_formula_explanation**](docs/PropertyDefinitionsApi.md#get_derived_formula_explanation) | **GET** /api/propertydefinitions/derived/$formulaExplanation | [INTERNAL] GetDerivedFormulaExplanation: Get explanation of a derived property formula
 *PropertyDefinitionsApi* | [**get_multiple_property_definitions**](docs/PropertyDefinitionsApi.md#get_multiple_property_definitions) | **GET** /api/propertydefinitions | GetMultiplePropertyDefinitions: Get multiple property definitions
 *PropertyDefinitionsApi* | [**get_property_definition**](docs/PropertyDefinitionsApi.md#get_property_definition) | **GET** /api/propertydefinitions/{domain}/{scope}/{code} | GetPropertyDefinition: Get property definition
 *PropertyDefinitionsApi* | [**get_property_definition_property_time_series**](docs/PropertyDefinitionsApi.md#get_property_definition_property_time_series) | **GET** /api/propertydefinitions/{domain}/{scope}/{code}/properties/time-series | [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series
@@ -1004,6 +1005,8 @@ Class | Method | HTTP request | Description
  - [DependencySourceFilter](docs/DependencySourceFilter.md)
  - [DepositCloseEvent](docs/DepositCloseEvent.md)
  - [DepositInterestPaymentEvent](docs/DepositInterestPaymentEvent.md)
+ - [DerivationFormulaExplainRequest](docs/DerivationFormulaExplainRequest.md)
+ - [DerivedPropertyComponent](docs/DerivedPropertyComponent.md)
  - [DescribedAddressKey](docs/DescribedAddressKey.md)
  - [Dialect](docs/Dialect.md)
  - [DialectId](docs/DialectId.md)

{lusid_sdk-2.1.979 → lusid_sdk-2.1.981}/lusid/__init__.py

@@ -442,6 +442,8 @@ from lusid.models.deleted_entity_response import DeletedEntityResponse
 from lusid.models.dependency_source_filter import DependencySourceFilter
 from lusid.models.deposit_close_event import DepositCloseEvent
 from lusid.models.deposit_interest_payment_event import DepositInterestPaymentEvent
+from lusid.models.derivation_formula_explain_request import DerivationFormulaExplainRequest
+from lusid.models.derived_property_component import DerivedPropertyComponent
 from lusid.models.described_address_key import DescribedAddressKey
 from lusid.models.dialect import Dialect
 from lusid.models.dialect_id import DialectId
@@ -1830,6 +1832,8 @@ __all__ = [
     "DependencySourceFilter",
     "DepositCloseEvent",
     "DepositInterestPaymentEvent",
+    "DerivationFormulaExplainRequest",
+    "DerivedPropertyComponent",
     "DescribedAddressKey",
     "Dialect",
     "DialectId",

{lusid_sdk-2.1.979 → lusid_sdk-2.1.981}/lusid/api/property_definitions_api.py

@@ -30,6 +30,8 @@ from lusid.models.batch_upsert_property_definition_properties_response import Ba
 from lusid.models.create_derived_property_definition_request import CreateDerivedPropertyDefinitionRequest
 from lusid.models.create_property_definition_request import CreatePropertyDefinitionRequest
 from lusid.models.deleted_entity_response import DeletedEntityResponse
+from lusid.models.derivation_formula_explain_request import DerivationFormulaExplainRequest
+from lusid.models.derived_property_component import DerivedPropertyComponent
 from lusid.models.model_property import ModelProperty
 from lusid.models.paged_resource_list_of_property_definition import PagedResourceListOfPropertyDefinition
 from lusid.models.property_definition import PropertyDefinition
@@ -741,6 +743,184 @@ class PropertyDefinitionsApi:
             _request_auth=_params.get('_request_auth'))
 
 
+    @overload
+    async def get_derived_formula_explanation(self, derivation_formula_explain_request : Annotated[DerivationFormulaExplainRequest, Field(..., description="Information about the derivation formula to explain, and optionally, the entity to resolve the formula against.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to resolve the entity. Defaults to returning the latest asAt in LUSID              if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to resolve the entity. Defaults to the current LUSID              system datetime if not specified.")] = None, **kwargs) -> DerivedPropertyComponent:  # noqa: E501
+        ...
+
+    @overload
+    def get_derived_formula_explanation(self, derivation_formula_explain_request : Annotated[DerivationFormulaExplainRequest, Field(..., description="Information about the derivation formula to explain, and optionally, the entity to resolve the formula against.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to resolve the entity. Defaults to returning the latest asAt in LUSID              if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to resolve the entity. Defaults to the current LUSID              system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> DerivedPropertyComponent:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def get_derived_formula_explanation(self, derivation_formula_explain_request : Annotated[DerivationFormulaExplainRequest, Field(..., description="Information about the derivation formula to explain, and optionally, the entity to resolve the formula against.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to resolve the entity. Defaults to returning the latest asAt in LUSID              if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to resolve the entity. Defaults to the current LUSID              system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DerivedPropertyComponent, Awaitable[DerivedPropertyComponent]]:  # noqa: E501
+        """[INTERNAL] GetDerivedFormulaExplanation: Get explanation of a derived property formula  # noqa: E501
+
+        Produces a manifest that shows the nested hierarchy of any source properties and the actions taken upon them to create the derived property.  This can either be done against an existing entity, which will produce a manifest that includes the values of the source properties  at the specified effective date time, or it can be done without providing an entity which will produce a manifest without values.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_derived_formula_explanation(derivation_formula_explain_request, as_at, effective_at, async_req=True)
+        >>> result = thread.get()
+
+        :param derivation_formula_explain_request: Information about the derivation formula to explain, and optionally, the entity to resolve the formula against. (required)
+        :type derivation_formula_explain_request: DerivationFormulaExplainRequest
+        :param as_at: The asAt datetime at which to resolve the entity. Defaults to returning the latest asAt in LUSID              if not specified.
+        :type as_at: datetime
+        :param effective_at: The effective datetime or cut label at which to resolve the entity. Defaults to the current LUSID              system datetime if not specified.
+        :type effective_at: 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: DerivedPropertyComponent
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the get_derived_formula_explanation_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.get_derived_formula_explanation_with_http_info(derivation_formula_explain_request, as_at, effective_at, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def get_derived_formula_explanation_with_http_info(self, derivation_formula_explain_request : Annotated[DerivationFormulaExplainRequest, Field(..., description="Information about the derivation formula to explain, and optionally, the entity to resolve the formula against.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to resolve the entity. Defaults to returning the latest asAt in LUSID              if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to resolve the entity. Defaults to the current LUSID              system datetime if not specified.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """[INTERNAL] GetDerivedFormulaExplanation: Get explanation of a derived property formula  # noqa: E501
+
+        Produces a manifest that shows the nested hierarchy of any source properties and the actions taken upon them to create the derived property.  This can either be done against an existing entity, which will produce a manifest that includes the values of the source properties  at the specified effective date time, or it can be done without providing an entity which will produce a manifest without values.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_derived_formula_explanation_with_http_info(derivation_formula_explain_request, as_at, effective_at, async_req=True)
+        >>> result = thread.get()
+
+        :param derivation_formula_explain_request: Information about the derivation formula to explain, and optionally, the entity to resolve the formula against. (required)
+        :type derivation_formula_explain_request: DerivationFormulaExplainRequest
+        :param as_at: The asAt datetime at which to resolve the entity. Defaults to returning the latest asAt in LUSID              if not specified.
+        :type as_at: datetime
+        :param effective_at: The effective datetime or cut label at which to resolve the entity. Defaults to the current LUSID              system datetime if not specified.
+        :type effective_at: 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(DerivedPropertyComponent, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'derivation_formula_explain_request',
+            'as_at',
+            'effective_at'
+        ]
+        _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 get_derived_formula_explanation" % _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('effective_at') is not None:  # noqa: E501
+            _query_params.append(('effectiveAt', _params['effective_at']))
+
+        # 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['derivation_formula_explain_request'] is not None:
+            _body_params = _params['derivation_formula_explain_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': "DerivedPropertyComponent",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/propertydefinitions/derived/$formulaExplanation', '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 get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should              be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definitions. Defaults to return              the latest version of each definition if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.               For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\"              Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition.              Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ResourceListOfPropertyDefinition:  # noqa: E501
         ...

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

{lusid_sdk-2.1.979 → lusid_sdk-2.1.981}/lusid/models/__init__.py

@@ -351,6 +351,8 @@ from lusid.models.deleted_entity_response import DeletedEntityResponse
 from lusid.models.dependency_source_filter import DependencySourceFilter
 from lusid.models.deposit_close_event import DepositCloseEvent
 from lusid.models.deposit_interest_payment_event import DepositInterestPaymentEvent
+from lusid.models.derivation_formula_explain_request import DerivationFormulaExplainRequest
+from lusid.models.derived_property_component import DerivedPropertyComponent
 from lusid.models.described_address_key import DescribedAddressKey
 from lusid.models.dialect import Dialect
 from lusid.models.dialect_id import DialectId
@@ -1649,6 +1651,8 @@ __all__ = [
     "DependencySourceFilter",
     "DepositCloseEvent",
     "DepositInterestPaymentEvent",
+    "DerivationFormulaExplainRequest",
+    "DerivedPropertyComponent",
     "DescribedAddressKey",
     "Dialect",
     "DialectId",

lusid_sdk-2.1.981/lusid/models/derivation_formula_explain_request.py

@@ -0,0 +1,105 @@
+# 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, validator 
+
+class DerivationFormulaExplainRequest(BaseModel):
+    """
+    DerivationFormulaExplainRequest
+    """
+    entity_type:  StrictStr = Field(...,alias="entityType", description="The type of the entity for which the derived property or partial formula is to be resolved against.") 
+    scope:  Optional[StrictStr] = Field(None,alias="scope", description="The scope that entity exists in. If no scope is provided, the default scope for the entity type will be used.") 
+    identifier: Optional[Dict[str, StrictStr]] = Field(None, description="An identifier key/value pair that uniquely identifies the entity to explain the derived property for. This can be either an instrument identifier, an identifier property, or a scope/code identifier which take the format {entityType}/default/code : {identifier}. If no identifiers are provided, the logical evaluation tree without resolved values is returned.")
+    property_key:  Optional[StrictStr] = Field(None,alias="propertyKey", description="The key of the derived property to explain. This takes the format {domain}/{scope}/{code}.") 
+    partial_formula:  Optional[StrictStr] = Field(None,alias="partialFormula", description="A partial derivation formula to explain. Can be provided in lieu of a property key.") 
+    __properties = ["entityType", "scope", "identifier", "propertyKey", "partialFormula"]
+
+    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) -> DerivationFormulaExplainRequest:
+        """Create an instance of DerivationFormulaExplainRequest 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)
+        # set to None if scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.scope is None and "scope" in self.__fields_set__:
+            _dict['scope'] = None
+
+        # set to None if identifier (nullable) is None
+        # and __fields_set__ contains the field
+        if self.identifier is None and "identifier" in self.__fields_set__:
+            _dict['identifier'] = None
+
+        # set to None if property_key (nullable) is None
+        # and __fields_set__ contains the field
+        if self.property_key is None and "property_key" in self.__fields_set__:
+            _dict['propertyKey'] = None
+
+        # set to None if partial_formula (nullable) is None
+        # and __fields_set__ contains the field
+        if self.partial_formula is None and "partial_formula" in self.__fields_set__:
+            _dict['partialFormula'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> DerivationFormulaExplainRequest:
+        """Create an instance of DerivationFormulaExplainRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return DerivationFormulaExplainRequest.parse_obj(obj)
+
+        _obj = DerivationFormulaExplainRequest.parse_obj({
+            "entity_type": obj.get("entityType"),
+            "scope": obj.get("scope"),
+            "identifier": obj.get("identifier"),
+            "property_key": obj.get("propertyKey"),
+            "partial_formula": obj.get("partialFormula")
+        })
+        return _obj

lusid_sdk-2.1.981/lusid/models/derived_property_component.py

@@ -0,0 +1,131 @@
+# 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.property_value import PropertyValue
+
+class DerivedPropertyComponent(BaseModel):
+    """
+    DerivedPropertyComponent
+    """
+    component:  Optional[StrictStr] = Field(None,alias="component", description="The component of the formula which is being evaluated.") 
+    type:  Optional[StrictStr] = Field(None,alias="type", description="The type of the formula component. This can be a Literal, Variable, DerivedProperty, or PartialFormula.") 
+    value: Optional[PropertyValue] = None
+    derivation_formula:  Optional[StrictStr] = Field(None,alias="derivationFormula", description="The derivation formula of the component. This field will only be populated if the component is a derived property.") 
+    sub_components: Optional[conlist(DerivedPropertyComponent)] = Field(None, alias="subComponents", description="Any sub-components of this formula. If this formula cannot be further decomposed, this collection will be null.")
+    links: Optional[conlist(Link)] = None
+    __properties = ["component", "type", "value", "derivationFormula", "subComponents", "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) -> DerivedPropertyComponent:
+        """Create an instance of DerivedPropertyComponent 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 value
+        if self.value:
+            _dict['value'] = self.value.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in sub_components (list)
+        _items = []
+        if self.sub_components:
+            for _item in self.sub_components:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['subComponents'] = _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 component (nullable) is None
+        # and __fields_set__ contains the field
+        if self.component is None and "component" in self.__fields_set__:
+            _dict['component'] = None
+
+        # set to None if type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.type is None and "type" in self.__fields_set__:
+            _dict['type'] = None
+
+        # set to None if derivation_formula (nullable) is None
+        # and __fields_set__ contains the field
+        if self.derivation_formula is None and "derivation_formula" in self.__fields_set__:
+            _dict['derivationFormula'] = None
+
+        # set to None if sub_components (nullable) is None
+        # and __fields_set__ contains the field
+        if self.sub_components is None and "sub_components" in self.__fields_set__:
+            _dict['subComponents'] = 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) -> DerivedPropertyComponent:
+        """Create an instance of DerivedPropertyComponent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return DerivedPropertyComponent.parse_obj(obj)
+
+        _obj = DerivedPropertyComponent.parse_obj({
+            "component": obj.get("component"),
+            "type": obj.get("type"),
+            "value": PropertyValue.from_dict(obj.get("value")) if obj.get("value") is not None else None,
+            "derivation_formula": obj.get("derivationFormula"),
+            "sub_components": [DerivedPropertyComponent.from_dict(_item) for _item in obj.get("subComponents")] if obj.get("subComponents") is not None else None,
+            "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.979 → lusid_sdk-2.1.981}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "lusid-sdk"
-version = "2.1.979"
+version = "2.1.981"
 description = "LUSID API"
 authors = ["FINBOURNE Technology <info@finbourne.com>"]
 license = "MIT"