lusid-sdk 1.1.250__py3-none-any.whl → 2.0.455__py3-none-any.whl

lusid/models/valuation_request.py

@@ -5,539 +5,167 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.250
     Contact: info@finbourne.com
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """
 
 
-try:
-    from inspect import getfullargspec
-except ImportError:
-    from inspect import getargspec as getfullargspec
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import six
-
-from lusid.configuration import Configuration
-
-
-class ValuationRequest(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
+import json
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist, constr
+from lusid.models.aggregate_spec import AggregateSpec
+from lusid.models.market_data_overrides import MarketDataOverrides
+from lusid.models.order_by_spec import OrderBySpec
+from lusid.models.order_flow_configuration import OrderFlowConfiguration
+from lusid.models.portfolio_entity_id import PortfolioEntityId
+from lusid.models.property_filter import PropertyFilter
+from lusid.models.resource_id import ResourceId
+from lusid.models.valuation_schedule import ValuationSchedule
+
+class ValuationRequest(BaseModel):
     """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-      required_map (dict): The key is attribute name
-                           and the value is whether it is 'required' or 'optional'.
+    Specification object for the parameters of a valuation  # noqa: E501
     """
-    openapi_types = {
-        'recipe_id': 'ResourceId',
-        'as_at': 'datetime',
-        'metrics': 'list[AggregateSpec]',
-        'group_by': 'list[str]',
-        'filters': 'list[PropertyFilter]',
-        'sort': 'list[OrderBySpec]',
-        'report_currency': 'str',
-        'equip_with_subtotals': 'bool',
-        'return_result_as_expanded_types': 'bool',
-        'include_order_flow': 'OrderFlowConfiguration',
-        'portfolio_entity_ids': 'list[PortfolioEntityId]',
-        'valuation_schedule': 'ValuationSchedule',
-        'market_data_overrides': 'MarketDataOverrides',
-        'corporate_action_source_id': 'ResourceId'
-    }
-
-    attribute_map = {
-        'recipe_id': 'recipeId',
-        'as_at': 'asAt',
-        'metrics': 'metrics',
-        'group_by': 'groupBy',
-        'filters': 'filters',
-        'sort': 'sort',
-        'report_currency': 'reportCurrency',
-        'equip_with_subtotals': 'equipWithSubtotals',
-        'return_result_as_expanded_types': 'returnResultAsExpandedTypes',
-        'include_order_flow': 'includeOrderFlow',
-        'portfolio_entity_ids': 'portfolioEntityIds',
-        'valuation_schedule': 'valuationSchedule',
-        'market_data_overrides': 'marketDataOverrides',
-        'corporate_action_source_id': 'corporateActionSourceId'
-    }
-
-    required_map = {
-        'recipe_id': 'required',
-        'as_at': 'optional',
-        'metrics': 'required',
-        'group_by': 'optional',
-        'filters': 'optional',
-        'sort': 'optional',
-        'report_currency': 'optional',
-        'equip_with_subtotals': 'optional',
-        'return_result_as_expanded_types': 'optional',
-        'include_order_flow': 'optional',
-        'portfolio_entity_ids': 'required',
-        'valuation_schedule': 'required',
-        'market_data_overrides': 'optional',
-        'corporate_action_source_id': 'optional'
-    }
-
-    def __init__(self, recipe_id=None, as_at=None, metrics=None, group_by=None, filters=None, sort=None, report_currency=None, equip_with_subtotals=None, return_result_as_expanded_types=None, include_order_flow=None, portfolio_entity_ids=None, valuation_schedule=None, market_data_overrides=None, corporate_action_source_id=None, local_vars_configuration=None):  # noqa: E501
-        """ValuationRequest - a model defined in OpenAPI"
-        
-        :param recipe_id:  (required)
-        :type recipe_id: lusid.ResourceId
-        :param as_at:  The asAt date to use
-        :type as_at: datetime
-        :param metrics:  The set of specifications to calculate or retrieve during the valuation and present in the results. For example:  AggregateSpec('Valuation/PV','Sum') for returning the PV (present value) of holdings  AggregateSpec('Holding/default/Units','Sum') for returning the units of holidays  AggregateSpec('Instrument/default/LusidInstrumentId','Value') for returning the Lusid Instrument identifier (required)
-        :type metrics: list[lusid.AggregateSpec]
-        :param group_by:  The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping  that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.
-        :type group_by: list[str]
-        :param filters:  A set of filters to use to reduce the data found in a request. Equivalent to the 'where ...' part of a Sql select statement.  For example, filter a set of values within a given range or matching a particular value.
-        :type filters: list[lusid.PropertyFilter]
-        :param sort:  A (possibly empty/null) set of specifications for how to order the results.
-        :type sort: list[lusid.OrderBySpec]
-        :param report_currency:  Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.  If not present, then the currency of the relevant portfolio will be used in its place.
-        :type report_currency: str
-        :param equip_with_subtotals:  Flag directing the Valuation call to populate the results with subtotals of aggregates.
-        :type equip_with_subtotals: bool
-        :param return_result_as_expanded_types:  Financially meaningful results can be presented as either simple flat types or more complex expanded types.  For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied)  or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example,  the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false.
-        :type return_result_as_expanded_types: bool
-        :param include_order_flow: 
-        :type include_order_flow: lusid.OrderFlowConfiguration
-        :param portfolio_entity_ids:  The set of portfolio or portfolio group identifier(s) that is to be valued. (required)
-        :type portfolio_entity_ids: list[lusid.PortfolioEntityId]
-        :param valuation_schedule:  (required)
-        :type valuation_schedule: lusid.ValuationSchedule
-        :param market_data_overrides: 
-        :type market_data_overrides: lusid.MarketDataOverrides
-        :param corporate_action_source_id: 
-        :type corporate_action_source_id: lusid.ResourceId
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._recipe_id = None
-        self._as_at = None
-        self._metrics = None
-        self._group_by = None
-        self._filters = None
-        self._sort = None
-        self._report_currency = None
-        self._equip_with_subtotals = None
-        self._return_result_as_expanded_types = None
-        self._include_order_flow = None
-        self._portfolio_entity_ids = None
-        self._valuation_schedule = None
-        self._market_data_overrides = None
-        self._corporate_action_source_id = None
-        self.discriminator = None
-
-        self.recipe_id = recipe_id
-        self.as_at = as_at
-        self.metrics = metrics
-        self.group_by = group_by
-        self.filters = filters
-        self.sort = sort
-        self.report_currency = report_currency
-        if equip_with_subtotals is not None:
-            self.equip_with_subtotals = equip_with_subtotals
-        if return_result_as_expanded_types is not None:
-            self.return_result_as_expanded_types = return_result_as_expanded_types
-        if include_order_flow is not None:
-            self.include_order_flow = include_order_flow
-        self.portfolio_entity_ids = portfolio_entity_ids
-        self.valuation_schedule = valuation_schedule
-        if market_data_overrides is not None:
-            self.market_data_overrides = market_data_overrides
-        if corporate_action_source_id is not None:
-            self.corporate_action_source_id = corporate_action_source_id
-
-    @property
-    def recipe_id(self):
-        """Gets the recipe_id of this ValuationRequest.  # noqa: E501
-
-
-        :return: The recipe_id of this ValuationRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._recipe_id
-
-    @recipe_id.setter
-    def recipe_id(self, recipe_id):
-        """Sets the recipe_id of this ValuationRequest.
-
-
-        :param recipe_id: The recipe_id of this ValuationRequest.  # noqa: E501
-        :type recipe_id: lusid.ResourceId
-        """
-        if self.local_vars_configuration.client_side_validation and recipe_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `recipe_id`, must not be `None`")  # noqa: E501
-
-        self._recipe_id = recipe_id
-
-    @property
-    def as_at(self):
-        """Gets the as_at of this ValuationRequest.  # noqa: E501
-
-        The asAt date to use  # noqa: E501
-
-        :return: The as_at of this ValuationRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._as_at
-
-    @as_at.setter
-    def as_at(self, as_at):
-        """Sets the as_at of this ValuationRequest.
-
-        The asAt date to use  # noqa: E501
-
-        :param as_at: The as_at of this ValuationRequest.  # noqa: E501
-        :type as_at: datetime
-        """
-
-        self._as_at = as_at
-
-    @property
-    def metrics(self):
-        """Gets the metrics of this ValuationRequest.  # noqa: E501
-
-        The set of specifications to calculate or retrieve during the valuation and present in the results. For example:  AggregateSpec('Valuation/PV','Sum') for returning the PV (present value) of holdings  AggregateSpec('Holding/default/Units','Sum') for returning the units of holidays  AggregateSpec('Instrument/default/LusidInstrumentId','Value') for returning the Lusid Instrument identifier  # noqa: E501
-
-        :return: The metrics of this ValuationRequest.  # noqa: E501
-        :rtype: list[lusid.AggregateSpec]
-        """
-        return self._metrics
-
-    @metrics.setter
-    def metrics(self, metrics):
-        """Sets the metrics of this ValuationRequest.
-
-        The set of specifications to calculate or retrieve during the valuation and present in the results. For example:  AggregateSpec('Valuation/PV','Sum') for returning the PV (present value) of holdings  AggregateSpec('Holding/default/Units','Sum') for returning the units of holidays  AggregateSpec('Instrument/default/LusidInstrumentId','Value') for returning the Lusid Instrument identifier  # noqa: E501
-
-        :param metrics: The metrics of this ValuationRequest.  # noqa: E501
-        :type metrics: list[lusid.AggregateSpec]
-        """
-        if self.local_vars_configuration.client_side_validation and metrics is None:  # noqa: E501
-            raise ValueError("Invalid value for `metrics`, must not be `None`")  # noqa: E501
-
-        self._metrics = metrics
-
-    @property
-    def group_by(self):
-        """Gets the group_by of this ValuationRequest.  # noqa: E501
-
-        The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping  that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.  # noqa: E501
-
-        :return: The group_by of this ValuationRequest.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._group_by
-
-    @group_by.setter
-    def group_by(self, group_by):
-        """Sets the group_by of this ValuationRequest.
-
-        The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping  that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.  # noqa: E501
-
-        :param group_by: The group_by of this ValuationRequest.  # noqa: E501
-        :type group_by: list[str]
-        """
-
-        self._group_by = group_by
-
-    @property
-    def filters(self):
-        """Gets the filters of this ValuationRequest.  # noqa: E501
-
-        A set of filters to use to reduce the data found in a request. Equivalent to the 'where ...' part of a Sql select statement.  For example, filter a set of values within a given range or matching a particular value.  # noqa: E501
-
-        :return: The filters of this ValuationRequest.  # noqa: E501
-        :rtype: list[lusid.PropertyFilter]
-        """
-        return self._filters
-
-    @filters.setter
-    def filters(self, filters):
-        """Sets the filters of this ValuationRequest.
-
-        A set of filters to use to reduce the data found in a request. Equivalent to the 'where ...' part of a Sql select statement.  For example, filter a set of values within a given range or matching a particular value.  # noqa: E501
-
-        :param filters: The filters of this ValuationRequest.  # noqa: E501
-        :type filters: list[lusid.PropertyFilter]
-        """
-
-        self._filters = filters
-
-    @property
-    def sort(self):
-        """Gets the sort of this ValuationRequest.  # noqa: E501
-
-        A (possibly empty/null) set of specifications for how to order the results.  # noqa: E501
-
-        :return: The sort of this ValuationRequest.  # noqa: E501
-        :rtype: list[lusid.OrderBySpec]
-        """
-        return self._sort
-
-    @sort.setter
-    def sort(self, sort):
-        """Sets the sort of this ValuationRequest.
-
-        A (possibly empty/null) set of specifications for how to order the results.  # noqa: E501
-
-        :param sort: The sort of this ValuationRequest.  # noqa: E501
-        :type sort: list[lusid.OrderBySpec]
-        """
-
-        self._sort = sort
-
-    @property
-    def report_currency(self):
-        """Gets the report_currency of this ValuationRequest.  # noqa: E501
-
-        Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.  If not present, then the currency of the relevant portfolio will be used in its place.  # noqa: E501
-
-        :return: The report_currency of this ValuationRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._report_currency
-
-    @report_currency.setter
-    def report_currency(self, report_currency):
-        """Sets the report_currency of this ValuationRequest.
-
-        Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.  If not present, then the currency of the relevant portfolio will be used in its place.  # noqa: E501
-
-        :param report_currency: The report_currency of this ValuationRequest.  # noqa: E501
-        :type report_currency: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                report_currency is not None and len(report_currency) > 3):
-            raise ValueError("Invalid value for `report_currency`, length must be less than or equal to `3`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                report_currency is not None and len(report_currency) < 0):
-            raise ValueError("Invalid value for `report_currency`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._report_currency = report_currency
-
-    @property
-    def equip_with_subtotals(self):
-        """Gets the equip_with_subtotals of this ValuationRequest.  # noqa: E501
-
-        Flag directing the Valuation call to populate the results with subtotals of aggregates.  # noqa: E501
-
-        :return: The equip_with_subtotals of this ValuationRequest.  # noqa: E501
-        :rtype: bool
-        """
-        return self._equip_with_subtotals
-
-    @equip_with_subtotals.setter
-    def equip_with_subtotals(self, equip_with_subtotals):
-        """Sets the equip_with_subtotals of this ValuationRequest.
-
-        Flag directing the Valuation call to populate the results with subtotals of aggregates.  # noqa: E501
-
-        :param equip_with_subtotals: The equip_with_subtotals of this ValuationRequest.  # noqa: E501
-        :type equip_with_subtotals: bool
-        """
-
-        self._equip_with_subtotals = equip_with_subtotals
-
-    @property
-    def return_result_as_expanded_types(self):
-        """Gets the return_result_as_expanded_types of this ValuationRequest.  # noqa: E501
-
-        Financially meaningful results can be presented as either simple flat types or more complex expanded types.  For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied)  or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example,  the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false.  # noqa: E501
-
-        :return: The return_result_as_expanded_types of this ValuationRequest.  # noqa: E501
-        :rtype: bool
-        """
-        return self._return_result_as_expanded_types
-
-    @return_result_as_expanded_types.setter
-    def return_result_as_expanded_types(self, return_result_as_expanded_types):
-        """Sets the return_result_as_expanded_types of this ValuationRequest.
-
-        Financially meaningful results can be presented as either simple flat types or more complex expanded types.  For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied)  or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example,  the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false.  # noqa: E501
-
-        :param return_result_as_expanded_types: The return_result_as_expanded_types of this ValuationRequest.  # noqa: E501
-        :type return_result_as_expanded_types: bool
-        """
-
-        self._return_result_as_expanded_types = return_result_as_expanded_types
-
-    @property
-    def include_order_flow(self):
-        """Gets the include_order_flow of this ValuationRequest.  # noqa: E501
-
-
-        :return: The include_order_flow of this ValuationRequest.  # noqa: E501
-        :rtype: lusid.OrderFlowConfiguration
-        """
-        return self._include_order_flow
-
-    @include_order_flow.setter
-    def include_order_flow(self, include_order_flow):
-        """Sets the include_order_flow of this ValuationRequest.
-
-
-        :param include_order_flow: The include_order_flow of this ValuationRequest.  # noqa: E501
-        :type include_order_flow: lusid.OrderFlowConfiguration
-        """
-
-        self._include_order_flow = include_order_flow
-
-    @property
-    def portfolio_entity_ids(self):
-        """Gets the portfolio_entity_ids of this ValuationRequest.  # noqa: E501
-
-        The set of portfolio or portfolio group identifier(s) that is to be valued.  # noqa: E501
-
-        :return: The portfolio_entity_ids of this ValuationRequest.  # noqa: E501
-        :rtype: list[lusid.PortfolioEntityId]
-        """
-        return self._portfolio_entity_ids
-
-    @portfolio_entity_ids.setter
-    def portfolio_entity_ids(self, portfolio_entity_ids):
-        """Sets the portfolio_entity_ids of this ValuationRequest.
-
-        The set of portfolio or portfolio group identifier(s) that is to be valued.  # noqa: E501
-
-        :param portfolio_entity_ids: The portfolio_entity_ids of this ValuationRequest.  # noqa: E501
-        :type portfolio_entity_ids: list[lusid.PortfolioEntityId]
-        """
-        if self.local_vars_configuration.client_side_validation and portfolio_entity_ids is None:  # noqa: E501
-            raise ValueError("Invalid value for `portfolio_entity_ids`, must not be `None`")  # noqa: E501
-
-        self._portfolio_entity_ids = portfolio_entity_ids
-
-    @property
-    def valuation_schedule(self):
-        """Gets the valuation_schedule of this ValuationRequest.  # noqa: E501
-
-
-        :return: The valuation_schedule of this ValuationRequest.  # noqa: E501
-        :rtype: lusid.ValuationSchedule
-        """
-        return self._valuation_schedule
-
-    @valuation_schedule.setter
-    def valuation_schedule(self, valuation_schedule):
-        """Sets the valuation_schedule of this ValuationRequest.
-
-
-        :param valuation_schedule: The valuation_schedule of this ValuationRequest.  # noqa: E501
-        :type valuation_schedule: lusid.ValuationSchedule
-        """
-        if self.local_vars_configuration.client_side_validation and valuation_schedule is None:  # noqa: E501
-            raise ValueError("Invalid value for `valuation_schedule`, must not be `None`")  # noqa: E501
-
-        self._valuation_schedule = valuation_schedule
-
-    @property
-    def market_data_overrides(self):
-        """Gets the market_data_overrides of this ValuationRequest.  # noqa: E501
-
-
-        :return: The market_data_overrides of this ValuationRequest.  # noqa: E501
-        :rtype: lusid.MarketDataOverrides
-        """
-        return self._market_data_overrides
-
-    @market_data_overrides.setter
-    def market_data_overrides(self, market_data_overrides):
-        """Sets the market_data_overrides of this ValuationRequest.
-
-
-        :param market_data_overrides: The market_data_overrides of this ValuationRequest.  # noqa: E501
-        :type market_data_overrides: lusid.MarketDataOverrides
-        """
-
-        self._market_data_overrides = market_data_overrides
-
-    @property
-    def corporate_action_source_id(self):
-        """Gets the corporate_action_source_id of this ValuationRequest.  # noqa: E501
-
-
-        :return: The corporate_action_source_id of this ValuationRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._corporate_action_source_id
-
-    @corporate_action_source_id.setter
-    def corporate_action_source_id(self, corporate_action_source_id):
-        """Sets the corporate_action_source_id of this ValuationRequest.
-
-
-        :param corporate_action_source_id: The corporate_action_source_id of this ValuationRequest.  # noqa: E501
-        :type corporate_action_source_id: lusid.ResourceId
-        """
-
-        self._corporate_action_source_id = corporate_action_source_id
-
-    def to_dict(self, serialize=False):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        def convert(x):
-            if hasattr(x, "to_dict"):
-                args = getfullargspec(x.to_dict).args
-                if len(args) == 1:
-                    return x.to_dict()
-                else:
-                    return x.to_dict(serialize)
-            else:
-                return x
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            attr = self.attribute_map.get(attr, attr) if serialize else attr
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: convert(x),
-                    value
-                ))
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], convert(item[1])),
-                    value.items()
-                ))
-            else:
-                result[attr] = convert(value)
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, ValuationRequest):
-            return False
-
-        return self.to_dict() == other.to_dict()
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, ValuationRequest):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    recipe_id: ResourceId = Field(..., alias="recipeId")
+    as_at: Optional[datetime] = Field(None, alias="asAt", description="The asAt date to use")
+    metrics: conlist(AggregateSpec) = Field(..., description="The set of specifications to calculate or retrieve during the valuation and present in the results. For example:  AggregateSpec('Valuation/PV','Sum') for returning the PV (present value) of holdings  AggregateSpec('Holding/default/Units','Sum') for returning the units of holidays  AggregateSpec('Instrument/default/LusidInstrumentId','Value') for returning the Lusid Instrument identifier")
+    group_by: Optional[conlist(StrictStr)] = Field(None, alias="groupBy", description="The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping  that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.")
+    filters: Optional[conlist(PropertyFilter)] = Field(None, description="A set of filters to use to reduce the data found in a request. Equivalent to the 'where ...' part of a Sql select statement.  For example, filter a set of values within a given range or matching a particular value.")
+    sort: Optional[conlist(OrderBySpec)] = Field(None, description="A (possibly empty/null) set of specifications for how to order the results.")
+    report_currency: Optional[constr(strict=True, max_length=3, min_length=0)] = Field(None, alias="reportCurrency", description="Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.  If not present, then the currency of the relevant portfolio will be used in its place.")
+    equip_with_subtotals: Optional[StrictBool] = Field(None, alias="equipWithSubtotals", description="Flag directing the Valuation call to populate the results with subtotals of aggregates.")
+    return_result_as_expanded_types: Optional[StrictBool] = Field(None, alias="returnResultAsExpandedTypes", description="Financially meaningful results can be presented as either simple flat types or more complex expanded types.  For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied)  or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example,  the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false.")
+    include_order_flow: Optional[OrderFlowConfiguration] = Field(None, alias="includeOrderFlow")
+    portfolio_entity_ids: conlist(PortfolioEntityId) = Field(..., alias="portfolioEntityIds", description="The set of portfolio or portfolio group identifier(s) that is to be valued.")
+    valuation_schedule: ValuationSchedule = Field(..., alias="valuationSchedule")
+    market_data_overrides: Optional[MarketDataOverrides] = Field(None, alias="marketDataOverrides")
+    corporate_action_source_id: Optional[ResourceId] = Field(None, alias="corporateActionSourceId")
+    __properties = ["recipeId", "asAt", "metrics", "groupBy", "filters", "sort", "reportCurrency", "equipWithSubtotals", "returnResultAsExpandedTypes", "includeOrderFlow", "portfolioEntityIds", "valuationSchedule", "marketDataOverrides", "corporateActionSourceId"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    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) -> ValuationRequest:
+        """Create an instance of ValuationRequest 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 recipe_id
+        if self.recipe_id:
+            _dict['recipeId'] = self.recipe_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
+        _items = []
+        if self.metrics:
+            for _item in self.metrics:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['metrics'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in filters (list)
+        _items = []
+        if self.filters:
+            for _item in self.filters:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in sort (list)
+        _items = []
+        if self.sort:
+            for _item in self.sort:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['sort'] = _items
+        # override the default output from pydantic by calling `to_dict()` of include_order_flow
+        if self.include_order_flow:
+            _dict['includeOrderFlow'] = self.include_order_flow.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in portfolio_entity_ids (list)
+        _items = []
+        if self.portfolio_entity_ids:
+            for _item in self.portfolio_entity_ids:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['portfolioEntityIds'] = _items
+        # override the default output from pydantic by calling `to_dict()` of valuation_schedule
+        if self.valuation_schedule:
+            _dict['valuationSchedule'] = self.valuation_schedule.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of market_data_overrides
+        if self.market_data_overrides:
+            _dict['marketDataOverrides'] = self.market_data_overrides.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of corporate_action_source_id
+        if self.corporate_action_source_id:
+            _dict['corporateActionSourceId'] = self.corporate_action_source_id.to_dict()
+        # set to None if as_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.as_at is None and "as_at" in self.__fields_set__:
+            _dict['asAt'] = None
+
+        # set to None if group_by (nullable) is None
+        # and __fields_set__ contains the field
+        if self.group_by is None and "group_by" in self.__fields_set__:
+            _dict['groupBy'] = None
+
+        # set to None if filters (nullable) is None
+        # and __fields_set__ contains the field
+        if self.filters is None and "filters" in self.__fields_set__:
+            _dict['filters'] = None
+
+        # set to None if sort (nullable) is None
+        # and __fields_set__ contains the field
+        if self.sort is None and "sort" in self.__fields_set__:
+            _dict['sort'] = None
+
+        # set to None if report_currency (nullable) is None
+        # and __fields_set__ contains the field
+        if self.report_currency is None and "report_currency" in self.__fields_set__:
+            _dict['reportCurrency'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ValuationRequest:
+        """Create an instance of ValuationRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ValuationRequest.parse_obj(obj)
+
+        _obj = ValuationRequest.parse_obj({
+            "recipe_id": ResourceId.from_dict(obj.get("recipeId")) if obj.get("recipeId") is not None else None,
+            "as_at": obj.get("asAt"),
+            "metrics": [AggregateSpec.from_dict(_item) for _item in obj.get("metrics")] if obj.get("metrics") is not None else None,
+            "group_by": obj.get("groupBy"),
+            "filters": [PropertyFilter.from_dict(_item) for _item in obj.get("filters")] if obj.get("filters") is not None else None,
+            "sort": [OrderBySpec.from_dict(_item) for _item in obj.get("sort")] if obj.get("sort") is not None else None,
+            "report_currency": obj.get("reportCurrency"),
+            "equip_with_subtotals": obj.get("equipWithSubtotals"),
+            "return_result_as_expanded_types": obj.get("returnResultAsExpandedTypes"),
+            "include_order_flow": OrderFlowConfiguration.from_dict(obj.get("includeOrderFlow")) if obj.get("includeOrderFlow") is not None else None,
+            "portfolio_entity_ids": [PortfolioEntityId.from_dict(_item) for _item in obj.get("portfolioEntityIds")] if obj.get("portfolioEntityIds") is not None else None,
+            "valuation_schedule": ValuationSchedule.from_dict(obj.get("valuationSchedule")) if obj.get("valuationSchedule") is not None else None,
+            "market_data_overrides": MarketDataOverrides.from_dict(obj.get("marketDataOverrides")) if obj.get("marketDataOverrides") is not None else None,
+            "corporate_action_source_id": ResourceId.from_dict(obj.get("corporateActionSourceId")) if obj.get("corporateActionSourceId") is not None else None
+        })
+        return _obj