# 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 List, Dict, Optional, Any, Union, TYPE_CHECKING
from typing_extensions import Annotated
from pydantic.v1 import BaseModel, StrictStr, StrictInt, StrictBool, StrictFloat, StrictBytes, Field, validator, ValidationError, conlist, constr
from datetime import datetime
from lusid.models.currency_and_amount import CurrencyAndAmount
from lusid.models.perpetual_property import PerpetualProperty
from lusid.models.resource_id import ResourceId
[docs]
class BlockRequest(BaseModel):
"""
A request to create or update a Block. # noqa: E501
"""
id: ResourceId
order_ids: Optional[List[ResourceId]] = Field(default=None, description="The related order ids.", alias="orderIds")
properties: Optional[Dict[str, PerpetualProperty]] = Field(default=None, description="Client-defined properties associated with this block.")
instrument_identifiers: Dict[str, Optional[StrictStr]] = Field(description="The instrument ordered.", alias="instrumentIdentifiers")
quantity: Union[StrictFloat, StrictInt] = Field(description="The total quantity of given instrument ordered.")
side: StrictStr = Field(...,alias="side", description="The client's representation of the block's side (buy, sell, short, etc)")
type: Optional[StrictStr] = Field(None,alias="type", description="The block order's type (examples: Limit, Market, ...)")
time_in_force: Optional[StrictStr] = Field(None,alias="timeInForce", description="The block orders' time in force (examples: Day, GoodTilCancel, ...)")
created_date: datetime = Field(description="The date on which the block was made", alias="createdDate")
limit_price: Optional[CurrencyAndAmount] = Field(default=None, alias="limitPrice")
stop_price: Optional[CurrencyAndAmount] = Field(default=None, alias="stopPrice")
is_swept: Optional[StrictBool] = Field(default=None, description="Swept blocks are considered no longer of active interest, and no longer take part in various order management processes", alias="isSwept")
__properties = ["id", "orderIds", "properties", "instrumentIdentifiers", "quantity", "side", "type", "timeInForce", "createdDate", "limitPrice", "stopPrice", "isSwept"]
[docs]
class Config:
"""Pydantic configuration"""
allow_population_by_field_name = True
validate_assignment = True
def __str__(self):
"""For `print` and `pprint`"""
return pprint.pformat(self.dict(by_alias=False))
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
[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) -> BlockRequest:
"""Create an instance of BlockRequest 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()
# set to None if order_ids (nullable) is None
# and __fields_set__ contains the field
if self.order_ids is None and "order_ids" in self.__fields_set__:
_dict['orderIds'] = None
# 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 type (nullable) is None
# and __fields_set__ contains the field
if self.type is None and "type" in self.__fields_set__:
_dict['type'] = None
# set to None if time_in_force (nullable) is None
# and __fields_set__ contains the field
if self.time_in_force is None and "time_in_force" in self.__fields_set__:
_dict['timeInForce'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> BlockRequest:
"""Create an instance of BlockRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return BlockRequest.parse_obj(obj)
_obj = BlockRequest.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"),
"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,
"is_swept": obj.get("isSwept")
})
return _obj
BlockRequest.update_forward_refs()