lusid-sdk 2.0.488__py3-none-any.whl → 2.1.5__py3-none-any.whl

lusid/configuration.py

@@ -373,7 +373,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.6435\n"\
+               "Version of the API: 0.11.6440\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

lusid/models/__init__.py

@@ -65,6 +65,8 @@ from lusid.models.allocation_request import AllocationRequest
 from lusid.models.allocation_service_run_response import AllocationServiceRunResponse
 from lusid.models.allocation_set_request import AllocationSetRequest
 from lusid.models.amortisation_event import AmortisationEvent
+from lusid.models.amortisation_rule import AmortisationRule
+from lusid.models.amortisation_rule_set import AmortisationRuleSet
 from lusid.models.annul_quotes_response import AnnulQuotesResponse
 from lusid.models.annul_single_structured_data_response import AnnulSingleStructuredDataResponse
 from lusid.models.annul_structured_data_response import AnnulStructuredDataResponse
@@ -179,6 +181,7 @@ from lusid.models.counterparty_agreement import CounterpartyAgreement
 from lusid.models.counterparty_risk_information import CounterpartyRiskInformation
 from lusid.models.counterparty_signatory import CounterpartySignatory
 from lusid.models.create_address_key_definition_request import CreateAddressKeyDefinitionRequest
+from lusid.models.create_amortisation_rule_set_request import CreateAmortisationRuleSetRequest
 from lusid.models.create_calendar_request import CreateCalendarRequest
 from lusid.models.create_corporate_action_source_request import CreateCorporateActionSourceRequest
 from lusid.models.create_custom_entity_type_request import CreateCustomEntityTypeRequest
@@ -510,6 +513,7 @@ from lusid.models.paged_resource_list_of_abor_configuration import PagedResource
 from lusid.models.paged_resource_list_of_account import PagedResourceListOfAccount
 from lusid.models.paged_resource_list_of_address_key_definition import PagedResourceListOfAddressKeyDefinition
 from lusid.models.paged_resource_list_of_allocation import PagedResourceListOfAllocation
+from lusid.models.paged_resource_list_of_amortisation_rule_set import PagedResourceListOfAmortisationRuleSet
 from lusid.models.paged_resource_list_of_block import PagedResourceListOfBlock
 from lusid.models.paged_resource_list_of_calendar import PagedResourceListOfCalendar
 from lusid.models.paged_resource_list_of_chart_of_accounts import PagedResourceListOfChartOfAccounts
@@ -853,6 +857,7 @@ from lusid.models.typed_resource_id import TypedResourceId
 from lusid.models.unit_schema import UnitSchema
 from lusid.models.units_ratio import UnitsRatio
 from lusid.models.unmatched_holding_method import UnmatchedHoldingMethod
+from lusid.models.update_amortisation_rule_set_details_request import UpdateAmortisationRuleSetDetailsRequest
 from lusid.models.update_calendar_request import UpdateCalendarRequest
 from lusid.models.update_custom_entity_definition_request import UpdateCustomEntityDefinitionRequest
 from lusid.models.update_custom_entity_type_request import UpdateCustomEntityTypeRequest
@@ -995,6 +1000,8 @@ __all__ = [
     "AllocationServiceRunResponse",
     "AllocationSetRequest",
     "AmortisationEvent",
+    "AmortisationRule",
+    "AmortisationRuleSet",
     "AnnulQuotesResponse",
     "AnnulSingleStructuredDataResponse",
     "AnnulStructuredDataResponse",
@@ -1109,6 +1116,7 @@ __all__ = [
     "CounterpartyRiskInformation",
     "CounterpartySignatory",
     "CreateAddressKeyDefinitionRequest",
+    "CreateAmortisationRuleSetRequest",
     "CreateCalendarRequest",
     "CreateCorporateActionSourceRequest",
     "CreateCustomEntityTypeRequest",
@@ -1440,6 +1448,7 @@ __all__ = [
     "PagedResourceListOfAccount",
     "PagedResourceListOfAddressKeyDefinition",
     "PagedResourceListOfAllocation",
+    "PagedResourceListOfAmortisationRuleSet",
     "PagedResourceListOfBlock",
     "PagedResourceListOfCalendar",
     "PagedResourceListOfChartOfAccounts",
@@ -1783,6 +1792,7 @@ __all__ = [
     "UnitSchema",
     "UnitsRatio",
     "UnmatchedHoldingMethod",
+    "UpdateAmortisationRuleSetDetailsRequest",
     "UpdateCalendarRequest",
     "UpdateCustomEntityDefinitionRequest",
     "UpdateCustomEntityTypeRequest",

lusid/models/amortisation_rule.py

@@ -0,0 +1,104 @@
+# 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 BaseModel, Field, constr, validator
+
+class AmortisationRule(BaseModel):
+    """
+    AmortisationRule
+    """
+    name: constr(strict=True, max_length=256, min_length=1) = Field(..., description="The name of the rule.")
+    description: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, description="A description of the rule.")
+    filter: constr(strict=True, max_length=16384, min_length=0) = Field(..., description="The filter for this rule.")
+    amortisation_method: constr(strict=True, min_length=1) = Field(..., alias="amortisationMethod", description="The filter for this rule.")
+    __properties = ["name", "description", "filter", "amortisationMethod"]
+
+    @validator('name')
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^\\<>&\"]+$", value):
+            raise ValueError(r"must validate the regular expression /^[^\\<>&\"]+$/")
+        return value
+
+    @validator('description')
+    def description_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
+
+    @validator('filter')
+    def filter_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        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) -> AmortisationRule:
+        """Create an instance of AmortisationRule 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 description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AmortisationRule:
+        """Create an instance of AmortisationRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AmortisationRule.parse_obj(obj)
+
+        _obj = AmortisationRule.parse_obj({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "filter": obj.get("filter"),
+            "amortisation_method": obj.get("amortisationMethod")
+        })
+        return _obj

lusid/models/amortisation_rule_set.py

@@ -0,0 +1,137 @@
+# 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 BaseModel, Field, StrictStr, conlist, constr, validator
+from lusid.models.amortisation_rule import AmortisationRule
+from lusid.models.link import Link
+from lusid.models.resource_id import ResourceId
+from lusid.models.version import Version
+
+class AmortisationRuleSet(BaseModel):
+    """
+    AmortisationRuleSet
+    """
+    href: Optional[StrictStr] = Field(None, description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
+    id: ResourceId = Field(...)
+    display_name: constr(strict=True, max_length=256, min_length=1) = Field(..., alias="displayName", description="A user-friendly name.")
+    description: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, description="A description of what this rule set is for.")
+    rules: conlist(AmortisationRule, max_items=100) = Field(..., description="The rules of this rule set.")
+    version: Optional[Version] = None
+    links: Optional[conlist(Link)] = None
+    __properties = ["href", "id", "displayName", "description", "rules", "version", "links"]
+
+    @validator('display_name')
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^\\<>&\"]+$", value):
+            raise ValueError(r"must validate the regular expression /^[^\\<>&\"]+$/")
+        return value
+
+    @validator('description')
+    def description_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) -> AmortisationRuleSet:
+        """Create an instance of AmortisationRuleSet from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in rules (list)
+        _items = []
+        if self.rules:
+            for _item in self.rules:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['rules'] = _items
+        # override the default output from pydantic by calling `to_dict()` of version
+        if self.version:
+            _dict['version'] = self.version.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if href (nullable) is None
+        # and __fields_set__ contains the field
+        if self.href is None and "href" in self.__fields_set__:
+            _dict['href'] = None
+
+        # set to None if description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = 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) -> AmortisationRuleSet:
+        """Create an instance of AmortisationRuleSet from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AmortisationRuleSet.parse_obj(obj)
+
+        _obj = AmortisationRuleSet.parse_obj({
+            "href": obj.get("href"),
+            "id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description"),
+            "rules": [AmortisationRule.from_dict(_item) for _item in obj.get("rules")] if obj.get("rules") is not None else None,
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") 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/models/create_amortisation_rule_set_request.py

@@ -0,0 +1,102 @@
+# 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 BaseModel, Field, constr, validator
+
+class CreateAmortisationRuleSetRequest(BaseModel):
+    """
+    CreateAmortisationRuleSetRequest
+    """
+    code: constr(strict=True, max_length=64, min_length=1) = Field(...)
+    display_name: constr(strict=True, max_length=256, min_length=1) = Field(..., alias="displayName")
+    description: Optional[constr(strict=True, max_length=1024, min_length=0)] = None
+    __properties = ["code", "displayName", "description"]
+
+    @validator('code')
+    def code_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('display_name')
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^\\<>&\"]+$", value):
+            raise ValueError(r"must validate the regular expression /^[^\\<>&\"]+$/")
+        return value
+
+    @validator('description')
+    def description_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) -> CreateAmortisationRuleSetRequest:
+        """Create an instance of CreateAmortisationRuleSetRequest 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 description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CreateAmortisationRuleSetRequest:
+        """Create an instance of CreateAmortisationRuleSetRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CreateAmortisationRuleSetRequest.parse_obj(obj)
+
+        _obj = CreateAmortisationRuleSetRequest.parse_obj({
+            "code": obj.get("code"),
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description")
+        })
+        return _obj

lusid/models/paged_resource_list_of_amortisation_rule_set.py

@@ -0,0 +1,113 @@
+# 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 BaseModel, Field, StrictStr, conlist
+from lusid.models.amortisation_rule_set import AmortisationRuleSet
+from lusid.models.link import Link
+
+class PagedResourceListOfAmortisationRuleSet(BaseModel):
+    """
+    PagedResourceListOfAmortisationRuleSet
+    """
+    next_page: Optional[StrictStr] = Field(None, alias="nextPage")
+    previous_page: Optional[StrictStr] = Field(None, alias="previousPage")
+    values: conlist(AmortisationRuleSet) = Field(...)
+    href: Optional[StrictStr] = None
+    links: Optional[conlist(Link)] = None
+    __properties = ["nextPage", "previousPage", "values", "href", "links"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def 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) -> PagedResourceListOfAmortisationRuleSet:
+        """Create an instance of PagedResourceListOfAmortisationRuleSet from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in values (list)
+        _items = []
+        if self.values:
+            for _item in self.values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['values'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if next_page (nullable) is None
+        # and __fields_set__ contains the field
+        if self.next_page is None and "next_page" in self.__fields_set__:
+            _dict['nextPage'] = None
+
+        # set to None if previous_page (nullable) is None
+        # and __fields_set__ contains the field
+        if self.previous_page is None and "previous_page" in self.__fields_set__:
+            _dict['previousPage'] = None
+
+        # set to None if href (nullable) is None
+        # and __fields_set__ contains the field
+        if self.href is None and "href" in self.__fields_set__:
+            _dict['href'] = None
+
+        # set to None if links (nullable) is None
+        # and __fields_set__ contains the field
+        if self.links is None and "links" in self.__fields_set__:
+            _dict['links'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PagedResourceListOfAmortisationRuleSet:
+        """Create an instance of PagedResourceListOfAmortisationRuleSet from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PagedResourceListOfAmortisationRuleSet.parse_obj(obj)
+
+        _obj = PagedResourceListOfAmortisationRuleSet.parse_obj({
+            "next_page": obj.get("nextPage"),
+            "previous_page": obj.get("previousPage"),
+            "values": [AmortisationRuleSet.from_dict(_item) for _item in obj.get("values")] if obj.get("values") is not None else None,
+            "href": obj.get("href"),
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj

lusid/models/update_amortisation_rule_set_details_request.py

@@ -0,0 +1,93 @@
+# 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 BaseModel, Field, constr, validator
+
+class UpdateAmortisationRuleSetDetailsRequest(BaseModel):
+    """
+    UpdateAmortisationRuleSetDetailsRequest
+    """
+    display_name: constr(strict=True, max_length=256, min_length=1) = Field(..., alias="displayName")
+    description: Optional[constr(strict=True, max_length=1024, min_length=0)] = None
+    __properties = ["displayName", "description"]
+
+    @validator('display_name')
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^\\<>&\"]+$", value):
+            raise ValueError(r"must validate the regular expression /^[^\\<>&\"]+$/")
+        return value
+
+    @validator('description')
+    def description_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) -> UpdateAmortisationRuleSetDetailsRequest:
+        """Create an instance of UpdateAmortisationRuleSetDetailsRequest 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 description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> UpdateAmortisationRuleSetDetailsRequest:
+        """Create an instance of UpdateAmortisationRuleSetDetailsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return UpdateAmortisationRuleSetDetailsRequest.parse_obj(obj)
+
+        _obj = UpdateAmortisationRuleSetDetailsRequest.parse_obj({
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description")
+        })
+        return _obj