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

lusid/models/query_bucketed_cash_flows_request.py

@@ -5,649 +5,158 @@
 
     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
+import json
 
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist, constr, validator
+from lusid.models.bucketing_schedule import BucketingSchedule
+from lusid.models.portfolio_entity_id import PortfolioEntityId
+from lusid.models.resource_id import ResourceId
 
-class QueryBucketedCashFlowsRequest(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class QueryBucketedCashFlowsRequest(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'.
+    Query for bucketed cashflows from one or more portfolios.  # noqa: E501
     """
-    openapi_types = {
-        'as_at': 'datetime',
-        'window_start': 'datetime',
-        'window_end': 'datetime',
-        'portfolio_entity_ids': 'list[PortfolioEntityId]',
-        'effective_at': 'datetime',
-        'recipe_id': 'ResourceId',
-        'rounding_method': 'str',
-        'bucketing_dates': 'list[datetime]',
-        'bucketing_tenors': 'list[str]',
-        'report_currency': 'str',
-        'group_by': 'list[str]',
-        'addresses': 'list[str]',
-        'equip_with_subtotals': 'bool',
-        'exclude_unsettled_trades': 'bool',
-        'cash_flow_type': 'str',
-        'bucketing_schedule': 'BucketingSchedule',
-        'filter': 'str'
-    }
-
-    attribute_map = {
-        'as_at': 'asAt',
-        'window_start': 'windowStart',
-        'window_end': 'windowEnd',
-        'portfolio_entity_ids': 'portfolioEntityIds',
-        'effective_at': 'effectiveAt',
-        'recipe_id': 'recipeId',
-        'rounding_method': 'roundingMethod',
-        'bucketing_dates': 'bucketingDates',
-        'bucketing_tenors': 'bucketingTenors',
-        'report_currency': 'reportCurrency',
-        'group_by': 'groupBy',
-        'addresses': 'addresses',
-        'equip_with_subtotals': 'equipWithSubtotals',
-        'exclude_unsettled_trades': 'excludeUnsettledTrades',
-        'cash_flow_type': 'cashFlowType',
-        'bucketing_schedule': 'bucketingSchedule',
-        'filter': 'filter'
-    }
-
-    required_map = {
-        'as_at': 'optional',
-        'window_start': 'required',
-        'window_end': 'required',
-        'portfolio_entity_ids': 'required',
-        'effective_at': 'required',
-        'recipe_id': 'required',
-        'rounding_method': 'required',
-        'bucketing_dates': 'optional',
-        'bucketing_tenors': 'optional',
-        'report_currency': 'required',
-        'group_by': 'optional',
-        'addresses': 'optional',
-        'equip_with_subtotals': 'optional',
-        'exclude_unsettled_trades': 'optional',
-        'cash_flow_type': 'optional',
-        'bucketing_schedule': 'optional',
-        'filter': 'optional'
-    }
-
-    def __init__(self, as_at=None, window_start=None, window_end=None, portfolio_entity_ids=None, effective_at=None, recipe_id=None, rounding_method=None, bucketing_dates=None, bucketing_tenors=None, report_currency=None, group_by=None, addresses=None, equip_with_subtotals=None, exclude_unsettled_trades=None, cash_flow_type=None, bucketing_schedule=None, filter=None, local_vars_configuration=None):  # noqa: E501
-        """QueryBucketedCashFlowsRequest - a model defined in OpenAPI"
-        
-        :param as_at:  The time of the system at which to query for bucketed cashflows.
-        :type as_at: datetime
-        :param window_start:  The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  There is no lower bound if this is not specified. (required)
-        :type window_start: datetime
-        :param window_end:  The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  The upper bound defaults to 'today' if it is not specified (required)
-        :type window_end: datetime
-        :param portfolio_entity_ids:  The set of portfolios and portfolio groups to which the instrument events must belong. (required)
-        :type portfolio_entity_ids: list[lusid.PortfolioEntityId]
-        :param effective_at:  The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.  This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up.  For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt  is before the start of the range they are forward looking and will be expectations assuming the model supports that.  There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (required)
-        :type effective_at: datetime
-        :param recipe_id:  (required)
-        :type recipe_id: lusid.ResourceId
-        :param rounding_method:  When bucketing, there is not a unique way to allocate the bucket points.  RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp]. (required)
-        :type rounding_method: str
-        :param bucketing_dates:  A list of dates to perform cashflow bucketing upon.  If this is provided, the list of tenors for bucketing should be empty.
-        :type bucketing_dates: list[datetime]
-        :param bucketing_tenors:  A list of tenors to perform cashflow bucketing upon.  If this is provided, the list of dates for bucketing should be empty.
-        :type bucketing_tenors: list[str]
-        :param report_currency:  Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries. (required)
-        :type report_currency: str
-        :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 addresses:  The set of items that the user wishes to see in the results. If empty, will be defaulted to standard ones.
-        :type addresses: list[str]
-        :param equip_with_subtotals:  Flag directing the Valuation call to populate the results with subtotals of aggregates.
-        :type equip_with_subtotals: bool
-        :param exclude_unsettled_trades:  Flag directing the Valuation call to exclude cashflows from unsettled trades.  If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.
-        :type exclude_unsettled_trades: bool
-        :param cash_flow_type:  Indicate the requested cash flow representation InstrumentCashFlows or PortfolioCashFlows (GetCashLadder uses this)  Options: [InstrumentCashFlow, PortfolioCashFlow]
-        :type cash_flow_type: str
-        :param bucketing_schedule: 
-        :type bucketing_schedule: lusid.BucketingSchedule
-        :param filter: 
-        :type filter: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._as_at = None
-        self._window_start = None
-        self._window_end = None
-        self._portfolio_entity_ids = None
-        self._effective_at = None
-        self._recipe_id = None
-        self._rounding_method = None
-        self._bucketing_dates = None
-        self._bucketing_tenors = None
-        self._report_currency = None
-        self._group_by = None
-        self._addresses = None
-        self._equip_with_subtotals = None
-        self._exclude_unsettled_trades = None
-        self._cash_flow_type = None
-        self._bucketing_schedule = None
-        self._filter = None
-        self.discriminator = None
-
-        self.as_at = as_at
-        self.window_start = window_start
-        self.window_end = window_end
-        self.portfolio_entity_ids = portfolio_entity_ids
-        self.effective_at = effective_at
-        self.recipe_id = recipe_id
-        self.rounding_method = rounding_method
-        self.bucketing_dates = bucketing_dates
-        self.bucketing_tenors = bucketing_tenors
-        self.report_currency = report_currency
-        self.group_by = group_by
-        self.addresses = addresses
-        if equip_with_subtotals is not None:
-            self.equip_with_subtotals = equip_with_subtotals
-        if exclude_unsettled_trades is not None:
-            self.exclude_unsettled_trades = exclude_unsettled_trades
-        self.cash_flow_type = cash_flow_type
-        if bucketing_schedule is not None:
-            self.bucketing_schedule = bucketing_schedule
-        self.filter = filter
-
-    @property
-    def as_at(self):
-        """Gets the as_at of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        The time of the system at which to query for bucketed cashflows.  # noqa: E501
-
-        :return: The as_at of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._as_at
-
-    @as_at.setter
-    def as_at(self, as_at):
-        """Sets the as_at of this QueryBucketedCashFlowsRequest.
-
-        The time of the system at which to query for bucketed cashflows.  # noqa: E501
-
-        :param as_at: The as_at of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type as_at: datetime
-        """
-
-        self._as_at = as_at
-
-    @property
-    def window_start(self):
-        """Gets the window_start of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  There is no lower bound if this is not specified.  # noqa: E501
-
-        :return: The window_start of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._window_start
-
-    @window_start.setter
-    def window_start(self, window_start):
-        """Sets the window_start of this QueryBucketedCashFlowsRequest.
-
-        The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  There is no lower bound if this is not specified.  # noqa: E501
-
-        :param window_start: The window_start of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type window_start: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and window_start is None:  # noqa: E501
-            raise ValueError("Invalid value for `window_start`, must not be `None`")  # noqa: E501
-
-        self._window_start = window_start
-
-    @property
-    def window_end(self):
-        """Gets the window_end of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  The upper bound defaults to 'today' if it is not specified  # noqa: E501
-
-        :return: The window_end of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._window_end
-
-    @window_end.setter
-    def window_end(self, window_end):
-        """Sets the window_end of this QueryBucketedCashFlowsRequest.
-
-        The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  The upper bound defaults to 'today' if it is not specified  # noqa: E501
-
-        :param window_end: The window_end of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type window_end: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and window_end is None:  # noqa: E501
-            raise ValueError("Invalid value for `window_end`, must not be `None`")  # noqa: E501
-
-        self._window_end = window_end
-
-    @property
-    def portfolio_entity_ids(self):
-        """Gets the portfolio_entity_ids of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        The set of portfolios and portfolio groups to which the instrument events must belong.  # noqa: E501
-
-        :return: The portfolio_entity_ids of this QueryBucketedCashFlowsRequest.  # 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 QueryBucketedCashFlowsRequest.
-
-        The set of portfolios and portfolio groups to which the instrument events must belong.  # noqa: E501
-
-        :param portfolio_entity_ids: The portfolio_entity_ids of this QueryBucketedCashFlowsRequest.  # 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 effective_at(self):
-        """Gets the effective_at of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.  This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up.  For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt  is before the start of the range they are forward looking and will be expectations assuming the model supports that.  There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.  # noqa: E501
-
-        :return: The effective_at of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._effective_at
-
-    @effective_at.setter
-    def effective_at(self, effective_at):
-        """Sets the effective_at of this QueryBucketedCashFlowsRequest.
-
-        The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.  This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up.  For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt  is before the start of the range they are forward looking and will be expectations assuming the model supports that.  There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.  # noqa: E501
-
-        :param effective_at: The effective_at of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type effective_at: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and effective_at is None:  # noqa: E501
-            raise ValueError("Invalid value for `effective_at`, must not be `None`")  # noqa: E501
-
-        self._effective_at = effective_at
-
-    @property
-    def recipe_id(self):
-        """Gets the recipe_id of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-
-        :return: The recipe_id of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._recipe_id
-
-    @recipe_id.setter
-    def recipe_id(self, recipe_id):
-        """Sets the recipe_id of this QueryBucketedCashFlowsRequest.
-
-
-        :param recipe_id: The recipe_id of this QueryBucketedCashFlowsRequest.  # 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 rounding_method(self):
-        """Gets the rounding_method of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        When bucketing, there is not a unique way to allocate the bucket points.  RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp].  # noqa: E501
-
-        :return: The rounding_method of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._rounding_method
-
-    @rounding_method.setter
-    def rounding_method(self, rounding_method):
-        """Sets the rounding_method of this QueryBucketedCashFlowsRequest.
-
-        When bucketing, there is not a unique way to allocate the bucket points.  RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp].  # noqa: E501
-
-        :param rounding_method: The rounding_method of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type rounding_method: str
-        """
-        if self.local_vars_configuration.client_side_validation and rounding_method is None:  # noqa: E501
-            raise ValueError("Invalid value for `rounding_method`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                rounding_method is not None and len(rounding_method) < 1):
-            raise ValueError("Invalid value for `rounding_method`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._rounding_method = rounding_method
-
-    @property
-    def bucketing_dates(self):
-        """Gets the bucketing_dates of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        A list of dates to perform cashflow bucketing upon.  If this is provided, the list of tenors for bucketing should be empty.  # noqa: E501
-
-        :return: The bucketing_dates of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: list[datetime]
-        """
-        return self._bucketing_dates
-
-    @bucketing_dates.setter
-    def bucketing_dates(self, bucketing_dates):
-        """Sets the bucketing_dates of this QueryBucketedCashFlowsRequest.
-
-        A list of dates to perform cashflow bucketing upon.  If this is provided, the list of tenors for bucketing should be empty.  # noqa: E501
-
-        :param bucketing_dates: The bucketing_dates of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type bucketing_dates: list[datetime]
-        """
-
-        self._bucketing_dates = bucketing_dates
-
-    @property
-    def bucketing_tenors(self):
-        """Gets the bucketing_tenors of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        A list of tenors to perform cashflow bucketing upon.  If this is provided, the list of dates for bucketing should be empty.  # noqa: E501
-
-        :return: The bucketing_tenors of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._bucketing_tenors
-
-    @bucketing_tenors.setter
-    def bucketing_tenors(self, bucketing_tenors):
-        """Sets the bucketing_tenors of this QueryBucketedCashFlowsRequest.
-
-        A list of tenors to perform cashflow bucketing upon.  If this is provided, the list of dates for bucketing should be empty.  # noqa: E501
-
-        :param bucketing_tenors: The bucketing_tenors of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type bucketing_tenors: list[str]
-        """
-
-        self._bucketing_tenors = bucketing_tenors
-
-    @property
-    def report_currency(self):
-        """Gets the report_currency of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.  # noqa: E501
-
-        :return: The report_currency of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._report_currency
-
-    @report_currency.setter
-    def report_currency(self, report_currency):
-        """Sets the report_currency of this QueryBucketedCashFlowsRequest.
-
-        Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.  # noqa: E501
-
-        :param report_currency: The report_currency of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type report_currency: str
-        """
-        if self.local_vars_configuration.client_side_validation and report_currency is None:  # noqa: E501
-            raise ValueError("Invalid value for `report_currency`, must not be `None`")  # noqa: E501
-        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 group_by(self):
-        """Gets the group_by of this QueryBucketedCashFlowsRequest.  # 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 QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._group_by
-
-    @group_by.setter
-    def group_by(self, group_by):
-        """Sets the group_by of this QueryBucketedCashFlowsRequest.
-
-        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 QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type group_by: list[str]
-        """
-
-        self._group_by = group_by
-
-    @property
-    def addresses(self):
-        """Gets the addresses of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        The set of items that the user wishes to see in the results. If empty, will be defaulted to standard ones.  # noqa: E501
-
-        :return: The addresses of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._addresses
-
-    @addresses.setter
-    def addresses(self, addresses):
-        """Sets the addresses of this QueryBucketedCashFlowsRequest.
-
-        The set of items that the user wishes to see in the results. If empty, will be defaulted to standard ones.  # noqa: E501
-
-        :param addresses: The addresses of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type addresses: list[str]
-        """
-
-        self._addresses = addresses
-
-    @property
-    def equip_with_subtotals(self):
-        """Gets the equip_with_subtotals of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        Flag directing the Valuation call to populate the results with subtotals of aggregates.  # noqa: E501
-
-        :return: The equip_with_subtotals of this QueryBucketedCashFlowsRequest.  # 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 QueryBucketedCashFlowsRequest.
-
-        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 QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type equip_with_subtotals: bool
-        """
-
-        self._equip_with_subtotals = equip_with_subtotals
-
-    @property
-    def exclude_unsettled_trades(self):
-        """Gets the exclude_unsettled_trades of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        Flag directing the Valuation call to exclude cashflows from unsettled trades.  If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.  # noqa: E501
-
-        :return: The exclude_unsettled_trades of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: bool
-        """
-        return self._exclude_unsettled_trades
-
-    @exclude_unsettled_trades.setter
-    def exclude_unsettled_trades(self, exclude_unsettled_trades):
-        """Sets the exclude_unsettled_trades of this QueryBucketedCashFlowsRequest.
-
-        Flag directing the Valuation call to exclude cashflows from unsettled trades.  If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.  # noqa: E501
-
-        :param exclude_unsettled_trades: The exclude_unsettled_trades of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type exclude_unsettled_trades: bool
-        """
-
-        self._exclude_unsettled_trades = exclude_unsettled_trades
-
-    @property
-    def cash_flow_type(self):
-        """Gets the cash_flow_type of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-        Indicate the requested cash flow representation InstrumentCashFlows or PortfolioCashFlows (GetCashLadder uses this)  Options: [InstrumentCashFlow, PortfolioCashFlow]  # noqa: E501
-
-        :return: The cash_flow_type of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._cash_flow_type
-
-    @cash_flow_type.setter
-    def cash_flow_type(self, cash_flow_type):
-        """Sets the cash_flow_type of this QueryBucketedCashFlowsRequest.
-
-        Indicate the requested cash flow representation InstrumentCashFlows or PortfolioCashFlows (GetCashLadder uses this)  Options: [InstrumentCashFlow, PortfolioCashFlow]  # noqa: E501
-
-        :param cash_flow_type: The cash_flow_type of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type cash_flow_type: str
-        """
-
-        self._cash_flow_type = cash_flow_type
-
-    @property
-    def bucketing_schedule(self):
-        """Gets the bucketing_schedule of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-
-        :return: The bucketing_schedule of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: lusid.BucketingSchedule
-        """
-        return self._bucketing_schedule
-
-    @bucketing_schedule.setter
-    def bucketing_schedule(self, bucketing_schedule):
-        """Sets the bucketing_schedule of this QueryBucketedCashFlowsRequest.
-
-
-        :param bucketing_schedule: The bucketing_schedule of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type bucketing_schedule: lusid.BucketingSchedule
-        """
-
-        self._bucketing_schedule = bucketing_schedule
-
-    @property
-    def filter(self):
-        """Gets the filter of this QueryBucketedCashFlowsRequest.  # noqa: E501
-
-
-        :return: The filter of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._filter
-
-    @filter.setter
-    def filter(self, filter):
-        """Sets the filter of this QueryBucketedCashFlowsRequest.
-
-
-        :param filter: The filter of this QueryBucketedCashFlowsRequest.  # noqa: E501
-        :type filter: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                filter is not None and len(filter) > 16384):
-            raise ValueError("Invalid value for `filter`, length must be less than or equal to `16384`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                filter is not None and len(filter) < 0):
-            raise ValueError("Invalid value for `filter`, length must be greater than or equal to `0`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                filter is not None and not re.search(r'^[\s\S]*$', filter)):  # noqa: E501
-            raise ValueError(r"Invalid value for `filter`, must be a follow pattern or equal to `/^[\s\S]*$/`")  # noqa: E501
-
-        self._filter = filter
-
-    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, QueryBucketedCashFlowsRequest):
-            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, QueryBucketedCashFlowsRequest):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    as_at: Optional[datetime] = Field(None, alias="asAt", description="The time of the system at which to query for bucketed cashflows.")
+    window_start: datetime = Field(..., alias="windowStart", description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  There is no lower bound if this is not specified.")
+    window_end: datetime = Field(..., alias="windowEnd", description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  The upper bound defaults to 'today' if it is not specified")
+    portfolio_entity_ids: conlist(PortfolioEntityId) = Field(..., alias="portfolioEntityIds", description="The set of portfolios and portfolio groups to which the instrument events must belong.")
+    effective_at: datetime = Field(..., alias="effectiveAt", description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.  This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up.  For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt  is before the start of the range they are forward looking and will be expectations assuming the model supports that.  There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")
+    recipe_id: ResourceId = Field(..., alias="recipeId")
+    rounding_method: constr(strict=True, min_length=1) = Field(..., alias="roundingMethod", description="When bucketing, there is not a unique way to allocate the bucket points.  RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp].")
+    bucketing_dates: Optional[conlist(datetime)] = Field(None, alias="bucketingDates", description="A list of dates to perform cashflow bucketing upon.  If this is provided, the list of tenors for bucketing should be empty.")
+    bucketing_tenors: Optional[conlist(StrictStr)] = Field(None, alias="bucketingTenors", description="A list of tenors to perform cashflow bucketing upon.  If this is provided, the list of dates for bucketing should be empty.")
+    report_currency: constr(strict=True, max_length=3, min_length=0) = Field(..., alias="reportCurrency", description="Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.")
+    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.")
+    addresses: Optional[conlist(StrictStr)] = Field(None, description="The set of items that the user wishes to see in the results. If empty, will be defaulted to standard ones.")
+    equip_with_subtotals: Optional[StrictBool] = Field(None, alias="equipWithSubtotals", description="Flag directing the Valuation call to populate the results with subtotals of aggregates.")
+    exclude_unsettled_trades: Optional[StrictBool] = Field(None, alias="excludeUnsettledTrades", description="Flag directing the Valuation call to exclude cashflows from unsettled trades.  If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")
+    cash_flow_type: Optional[StrictStr] = Field(None, alias="cashFlowType", description="Indicate the requested cash flow representation InstrumentCashFlows or PortfolioCashFlows (GetCashLadder uses this)  Options: [InstrumentCashFlow, PortfolioCashFlow]")
+    bucketing_schedule: Optional[BucketingSchedule] = Field(None, alias="bucketingSchedule")
+    filter: Optional[constr(strict=True, max_length=16384, min_length=0)] = None
+    __properties = ["asAt", "windowStart", "windowEnd", "portfolioEntityIds", "effectiveAt", "recipeId", "roundingMethod", "bucketingDates", "bucketingTenors", "reportCurrency", "groupBy", "addresses", "equipWithSubtotals", "excludeUnsettledTrades", "cashFlowType", "bucketingSchedule", "filter"]
+
+    @validator('filter')
+    def filter_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[\s\S]*$", value):
+            raise ValueError(r"must validate the regular expression /^[\s\S]*$/")
+        return value
+
+    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) -> QueryBucketedCashFlowsRequest:
+        """Create an instance of QueryBucketedCashFlowsRequest 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 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 recipe_id
+        if self.recipe_id:
+            _dict['recipeId'] = self.recipe_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of bucketing_schedule
+        if self.bucketing_schedule:
+            _dict['bucketingSchedule'] = self.bucketing_schedule.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 bucketing_dates (nullable) is None
+        # and __fields_set__ contains the field
+        if self.bucketing_dates is None and "bucketing_dates" in self.__fields_set__:
+            _dict['bucketingDates'] = None
+
+        # set to None if bucketing_tenors (nullable) is None
+        # and __fields_set__ contains the field
+        if self.bucketing_tenors is None and "bucketing_tenors" in self.__fields_set__:
+            _dict['bucketingTenors'] = 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 addresses (nullable) is None
+        # and __fields_set__ contains the field
+        if self.addresses is None and "addresses" in self.__fields_set__:
+            _dict['addresses'] = None
+
+        # set to None if cash_flow_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.cash_flow_type is None and "cash_flow_type" in self.__fields_set__:
+            _dict['cashFlowType'] = None
+
+        # set to None if filter (nullable) is None
+        # and __fields_set__ contains the field
+        if self.filter is None and "filter" in self.__fields_set__:
+            _dict['filter'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> QueryBucketedCashFlowsRequest:
+        """Create an instance of QueryBucketedCashFlowsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return QueryBucketedCashFlowsRequest.parse_obj(obj)
+
+        _obj = QueryBucketedCashFlowsRequest.parse_obj({
+            "as_at": obj.get("asAt"),
+            "window_start": obj.get("windowStart"),
+            "window_end": obj.get("windowEnd"),
+            "portfolio_entity_ids": [PortfolioEntityId.from_dict(_item) for _item in obj.get("portfolioEntityIds")] if obj.get("portfolioEntityIds") is not None else None,
+            "effective_at": obj.get("effectiveAt"),
+            "recipe_id": ResourceId.from_dict(obj.get("recipeId")) if obj.get("recipeId") is not None else None,
+            "rounding_method": obj.get("roundingMethod"),
+            "bucketing_dates": obj.get("bucketingDates"),
+            "bucketing_tenors": obj.get("bucketingTenors"),
+            "report_currency": obj.get("reportCurrency"),
+            "group_by": obj.get("groupBy"),
+            "addresses": obj.get("addresses"),
+            "equip_with_subtotals": obj.get("equipWithSubtotals"),
+            "exclude_unsettled_trades": obj.get("excludeUnsettledTrades"),
+            "cash_flow_type": obj.get("cashFlowType"),
+            "bucketing_schedule": BucketingSchedule.from_dict(obj.get("bucketingSchedule")) if obj.get("bucketingSchedule") is not None else None,
+            "filter": obj.get("filter")
+        })
+        return _obj