# 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 StrictStr, Field, BaseModel, Field, StrictBool, StrictStr, constr, validator
[docs]
class TransactionQueryParameters(BaseModel):
"""
TransactionQueryParameters
"""
start_date: StrictStr = Field(...,alias="startDate", description="The lower bound effective datetime or cut label (inclusive) from which to build the transactions.")
end_date: StrictStr = Field(...,alias="endDate", description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.")
query_mode: Optional[StrictStr] = Field(None,alias="queryMode", description="The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate")
show_cancelled_transactions: Optional[StrictBool] = Field(None, alias="showCancelledTransactions", description="Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified.")
timeline_scope: Optional[StrictStr] = Field(None,alias="timelineScope", description="Scope of the Timeline for the Portfolio. The Timeline to be used while building transactions")
timeline_code: Optional[StrictStr] = Field(None,alias="timelineCode", description="Code of the Timeline for the Portfolio. The Timeline to be used while building transactions")
__properties = ["startDate", "endDate", "queryMode", "showCancelledTransactions", "timelineScope", "timelineCode"]
[docs]
@validator('query_mode')
def query_mode_validate_enum(cls, value):
"""Validates the enum"""
# Finbourne have removed enum validation on all models, except for this use case:
# Workflow and notification application SDK use the property name 'type' as the discriminator on a number of classes.
# During instantiation, the value of 'type' is checked against the enum values,
# check it's a class that uses the 'type' property as a discriminator
# list of classes can be found by searching for 'actual_instance: Union[' in the generated code
if 'TransactionQueryParameters' not in [
# For notification application classes
'AmazonSqsNotificationType',
'AmazonSqsNotificationTypeResponse',
'AmazonSqsPrincipalAuthNotificationType',
'AmazonSqsPrincipalAuthNotificationTypeResponse',
'AzureServiceBusTypeResponse',
'AzureServiceBusNotificationType',
'EmailNotificationType',
'EmailNotificationTypeResponse',
'SmsNotificationType',
'SmsNotificationTypeResponse',
'WebhookNotificationType',
'WebhookNotificationTypeResponse',
# For workflow application classes
'CreateChildTasksAction',
'RunWorkerAction',
'TriggerParentTaskAction',
'CreateChildTasksActionResponse',
'RunWorkerActionResponse',
'TriggerParentTaskActionResponse',
'CreateNewTaskActivity',
'UpdateMatchingTasksActivity',
'CreateNewTaskActivityResponse',
'UpdateMatchingTasksActivityResponse',
'Fail',
'GroupReconciliation',
'HealthCheck',
'LuminesceView',
'SchedulerJob',
'Sleep',
'FailResponse',
'GroupReconciliationResponse',
'HealthCheckResponse',
'LuminesceViewResponse',
'SchedulerJobResponse',
'SleepResponse']:
return value
# Only validate the 'type' property of the class
if "query_mode" != "type":
return value
if value is None:
return value
if value not in ('TradeDate', 'SettleDate'):
raise ValueError("must be one of enum values ('TradeDate', 'SettleDate')")
return value
[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) -> TransactionQueryParameters:
"""Create an instance of TransactionQueryParameters 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)
# set to None if timeline_scope (nullable) is None
# and __fields_set__ contains the field
if self.timeline_scope is None and "timeline_scope" in self.__fields_set__:
_dict['timelineScope'] = None
# set to None if timeline_code (nullable) is None
# and __fields_set__ contains the field
if self.timeline_code is None and "timeline_code" in self.__fields_set__:
_dict['timelineCode'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> TransactionQueryParameters:
"""Create an instance of TransactionQueryParameters from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return TransactionQueryParameters.parse_obj(obj)
_obj = TransactionQueryParameters.parse_obj({
"start_date": obj.get("startDate"),
"end_date": obj.get("endDate"),
"query_mode": obj.get("queryMode"),
"show_cancelled_transactions": obj.get("showCancelledTransactions"),
"timeline_scope": obj.get("timelineScope"),
"timeline_code": obj.get("timelineCode")
})
return _obj