Source code for sdk.lusid.models.side_definition

# 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, conlist, constr
from lusid.models.link import Link

[docs] class SideDefinition(BaseModel): """ SideDefinition """ side: constr(strict=True, max_length=64, min_length=1) = Field(..., description="A unique label identifying the side definition.") security: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The field or property key defining the side's security, or instrument.") currency: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The field or property key defining the side's currency.") rate: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The field or property key defining the side's rate.") units: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The value, field or property key defining the side's units.") amount: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The value, field or property key defining the side's amount") notional_amount: Optional[constr(strict=True, max_length=64, min_length=1)] = Field(None, alias="notionalAmount", description="The value, field or property key defining the side's notional amount") links: Optional[conlist(Link)] = None __properties = ["side", "security", "currency", "rate", "units", "amount", "notionalAmount", "links"]
[docs] class Config: """Pydantic configuration""" allow_population_by_field_name = True validate_assignment = True
[docs] def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.dict(by_alias=True))
[docs] def to_json(self) -> str: """Returns the JSON representation of the model using alias""" return json.dumps(self.to_dict())
[docs] @classmethod def from_json(cls, json_str: str) -> SideDefinition: """Create an instance of SideDefinition from a JSON string""" return cls.from_dict(json.loads(json_str))
[docs] 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 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 notional_amount (nullable) is None # and __fields_set__ contains the field if self.notional_amount is None and "notional_amount" in self.__fields_set__: _dict['notionalAmount'] = 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
[docs] @classmethod def from_dict(cls, obj: dict) -> SideDefinition: """Create an instance of SideDefinition from a dict""" if obj is None: return None if not isinstance(obj, dict): return SideDefinition.parse_obj(obj) _obj = SideDefinition.parse_obj({ "side": obj.get("side"), "security": obj.get("security"), "currency": obj.get("currency"), "rate": obj.get("rate"), "units": obj.get("units"), "amount": obj.get("amount"), "notional_amount": obj.get("notionalAmount"), "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None }) return _obj