# 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 datetime import datetime
from typing import Any, Dict, List, Optional, Union
from pydantic.v1 import BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist, constr
from lusid.models.currency_and_amount import CurrencyAndAmount
from lusid.models.link import Link
from lusid.models.perpetual_property import PerpetualProperty
from lusid.models.resource_id import ResourceId
from lusid.models.version import Version
[docs]
class Block(BaseModel):
"""
A block of orders for the same instrument, intended to record for example a trader's aggregation of outstanding orders at a given time. # noqa: E501
"""
id: ResourceId = Field(...)
order_ids: conlist(ResourceId) = Field(..., alias="orderIds", description="The related order ids.")
properties: Optional[Dict[str, PerpetualProperty]] = Field(None, description="Client-defined properties associated with this block.")
instrument_identifiers: Dict[str, StrictStr] = Field(..., alias="instrumentIdentifiers", description="The instrument ordered.")
lusid_instrument_id: constr(strict=True, min_length=1) = Field(..., alias="lusidInstrumentId", description="The LUSID instrument id for the instrument ordered.")
quantity: Union[StrictFloat, StrictInt] = Field(..., description="The total quantity of given instrument ordered.")
side: constr(strict=True, min_length=1) = Field(..., description="The client's representation of the block's side (buy, sell, short, etc)")
type: constr(strict=True, min_length=1) = Field(..., description="The block order's type (examples: Limit, Market, ...)")
time_in_force: constr(strict=True, min_length=1) = Field(..., alias="timeInForce", description="The block orders' time in force (examples: Day, GoodTilCancel, ...)")
created_date: datetime = Field(..., alias="createdDate", description="The date on which the block was made")
limit_price: Optional[CurrencyAndAmount] = Field(None, alias="limitPrice")
stop_price: Optional[CurrencyAndAmount] = Field(None, alias="stopPrice")
version: Optional[Version] = None
links: Optional[conlist(Link)] = None
__properties = ["id", "orderIds", "properties", "instrumentIdentifiers", "lusidInstrumentId", "quantity", "side", "type", "timeInForce", "createdDate", "limitPrice", "stopPrice", "version", "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) -> Block:
"""Create an instance of Block 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 id
if self.id:
_dict['id'] = self.id.to_dict()
# override the default output from pydantic by calling `to_dict()` of each item in order_ids (list)
_items = []
if self.order_ids:
for _item in self.order_ids:
if _item:
_items.append(_item.to_dict())
_dict['orderIds'] = _items
# override the default output from pydantic by calling `to_dict()` of each value in properties (dict)
_field_dict = {}
if self.properties:
for _key in self.properties:
if self.properties[_key]:
_field_dict[_key] = self.properties[_key].to_dict()
_dict['properties'] = _field_dict
# override the default output from pydantic by calling `to_dict()` of limit_price
if self.limit_price:
_dict['limitPrice'] = self.limit_price.to_dict()
# override the default output from pydantic by calling `to_dict()` of stop_price
if self.stop_price:
_dict['stopPrice'] = self.stop_price.to_dict()
# 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 properties (nullable) is None
# and __fields_set__ contains the field
if self.properties is None and "properties" in self.__fields_set__:
_dict['properties'] = 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) -> Block:
"""Create an instance of Block from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return Block.parse_obj(obj)
_obj = Block.parse_obj({
"id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
"order_ids": [ResourceId.from_dict(_item) for _item in obj.get("orderIds")] if obj.get("orderIds") is not None else None,
"properties": dict(
(_k, PerpetualProperty.from_dict(_v))
for _k, _v in obj.get("properties").items()
)
if obj.get("properties") is not None
else None,
"instrument_identifiers": obj.get("instrumentIdentifiers"),
"lusid_instrument_id": obj.get("lusidInstrumentId"),
"quantity": obj.get("quantity"),
"side": obj.get("side"),
"type": obj.get("type"),
"time_in_force": obj.get("timeInForce"),
"created_date": obj.get("createdDate"),
"limit_price": CurrencyAndAmount.from_dict(obj.get("limitPrice")) if obj.get("limitPrice") is not None else None,
"stop_price": CurrencyAndAmount.from_dict(obj.get("stopPrice")) if obj.get("stopPrice") 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