pluggy-sdk 1.0.0.post34__py3-none-any.whl

pluggy_sdk/models/income_report.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IncomeReport(BaseModel):
+    """
+    Income report entity
+    """ # noqa: E501
+    url: Optional[StrictStr] = Field(default=None, description="URL of the income report file available to be downloaded from Amazon S3")
+    year: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Year to which the income report belongs")
+    __properties: ClassVar[List[str]] = ["url", "year"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of IncomeReport from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IncomeReport from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "year": obj.get("year")
+        })
+        return _obj
+
+

pluggy_sdk/models/income_reports_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pluggy_sdk.models.income_report import IncomeReport
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IncomeReportsResponse(BaseModel):
+    """
+    Response with the pages of metadata of the income reports files uploaded to Amazon S3
+    """ # noqa: E501
+    page: Optional[Union[StrictFloat, StrictInt]] = None
+    total: Optional[Union[StrictFloat, StrictInt]] = None
+    total_pages: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalPages")
+    results: Optional[List[IncomeReport]] = Field(default=None, description="Array with the metadata of every income report")
+    __properties: ClassVar[List[str]] = ["page", "total", "totalPages", "results"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of IncomeReportsResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in results (list)
+        _items = []
+        if self.results:
+            for _item_results in self.results:
+                if _item_results:
+                    _items.append(_item_results.to_dict())
+            _dict['results'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IncomeReportsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "page": obj.get("page"),
+            "total": obj.get("total"),
+            "totalPages": obj.get("totalPages"),
+            "results": [IncomeReport.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/investment.py

@@ -0,0 +1,192 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pluggy_sdk.models.investment_metadata import InvestmentMetadata
+from pluggy_sdk.models.investment_transaction import InvestmentTransaction
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Investment(BaseModel):
+    """
+    Investment representing a specific asset
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier")
+    item_id: StrictStr = Field(description="Identifier of the item linked to the investment", alias="itemId")
+    type: StrictStr = Field(description="Investment Asset type")
+    subtype: Optional[StrictStr] = Field(default=None, description="Investment subtype, depends on the type")
+    number: Optional[StrictStr] = Field(default=None, description="Reference number for this holder's asset")
+    balance: Union[StrictFloat, StrictInt] = Field(description="The current net balance amount of the investment")
+    name: StrictStr = Field(description="Name on the provider")
+    last_month_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The performance rate of the investment in the last month", alias="lastMonthRate")
+    last_twelve_months_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The performance rate of the investment in the last 12 months", alias="lastTwelveMonthsRate")
+    annual_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The performance rate of the investment in the last year", alias="annualRate")
+    currency_code: StrictStr = Field(description="Currency ISO code for the amounts", alias="currencyCode")
+    code: Optional[StrictStr] = Field(default=None, description="Associated Code for the investment. For example, the code for a mutual fund is the CNPJ")
+    isin: Optional[StrictStr] = Field(default=None, description="12-character ISIN, a globally unique identifier")
+    value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Quota's current value at \"date\"")
+    quantity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Quantity of quota at disposal")
+    amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Gross amount of the investment")
+    taxes: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Income taxes applied to the investment")
+    taxes2: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Financial taxes applied to the investment")
+    var_date: datetime = Field(description="Value's quota date", alias="date")
+    owner: Optional[StrictStr] = Field(default=None, description="Owner/beneficiary associated with the investment")
+    amount_profit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Profit/Loss to date over the investment", alias="amountProfit")
+    amount_withdrawal: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The amount available to withdraw", alias="amountWithdrawal")
+    amount_original: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Amount originally invested", alias="amountOriginal")
+    metadata: Optional[InvestmentMetadata] = Field(default=None, description="Security Portability details")
+    transactions: Optional[List[InvestmentTransaction]] = Field(default=None, description="(DEPRECATED: this field will be removed for new applications created from 21st March 2023 onward. Use the paginated `GET /investment/{id}/transactions` endpoint instead.) Transactions made on the investment (Buy, Sell, Transfer, Tax)")
+    due_date: Optional[datetime] = Field(default=None, description="Expiration Date", alias="dueDate")
+    issuer: Optional[StrictStr] = Field(default=None, description="The entity that issued the investment")
+    issuer_cnpj: Optional[StrictStr] = Field(default=None, description="The entity CNPJ that issued the investment", alias="issuerCNPJ")
+    issue_date: Optional[datetime] = Field(default=None, description="The date that the investment was issued", alias="issueDate")
+    rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Fixed rate percentage applied to the investment")
+    rate_type: Optional[StrictStr] = Field(default=None, description="Type of fixed-rate", alias="rateType")
+    fixed_annual_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Fixed income annual rate", alias="fixedAnnualRate")
+    status: Optional[StrictStr] = Field(default=None, description="Current status of the investment enum value")
+    __properties: ClassVar[List[str]] = ["id", "itemId", "type", "subtype", "number", "balance", "name", "lastMonthRate", "lastTwelveMonthsRate", "annualRate", "currencyCode", "code", "isin", "value", "quantity", "amount", "taxes", "taxes2", "date", "owner", "amountProfit", "amountWithdrawal", "amountOriginal", "metadata", "transactions", "dueDate", "issuer", "issuerCNPJ", "issueDate", "rate", "rateType", "fixedAnnualRate", "status"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['COE', 'EQUITY', 'ETF', 'FIXED_INCOME', 'MUTUAL_FUND', 'SECURITY', 'OTHER']):
+            raise ValueError("must be one of enum values ('COE', 'EQUITY', 'ETF', 'FIXED_INCOME', 'MUTUAL_FUND', 'SECURITY', 'OTHER')")
+        return value
+
+    @field_validator('subtype')
+    def subtype_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['STRUCTURED_NOTE', 'STOCK', 'ETF', 'REAL_ESTATE_FUND', 'BDR', 'DERIVATIVES', 'OPTION', 'TREASURY', 'LCI', 'LCA', 'LF', 'CDB', 'CRI', 'CRA', 'CORPORATE_DEBT', 'LC', 'DEBENTURES', 'INVESTMENT_FUND', 'MULTIMARKET_FUND', 'FIXED_INCOME_FUND', 'STOCK_FUND', 'ETF_FUND', 'OFFSHORE_FUND', 'FIP_FUND', 'EXCHANGE_FUND', 'RETIREMENT', 'OTHER']):
+            raise ValueError("must be one of enum values ('STRUCTURED_NOTE', 'STOCK', 'ETF', 'REAL_ESTATE_FUND', 'BDR', 'DERIVATIVES', 'OPTION', 'TREASURY', 'LCI', 'LCA', 'LF', 'CDB', 'CRI', 'CRA', 'CORPORATE_DEBT', 'LC', 'DEBENTURES', 'INVESTMENT_FUND', 'MULTIMARKET_FUND', 'FIXED_INCOME_FUND', 'STOCK_FUND', 'ETF_FUND', 'OFFSHORE_FUND', 'FIP_FUND', 'EXCHANGE_FUND', 'RETIREMENT', 'OTHER')")
+        return value
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ACTIVE', 'PENDING', 'TOTAL_WITHDRAWAL']):
+            raise ValueError("must be one of enum values ('ACTIVE', 'PENDING', 'TOTAL_WITHDRAWAL')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Investment from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of metadata
+        if self.metadata:
+            _dict['metadata'] = self.metadata.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in transactions (list)
+        _items = []
+        if self.transactions:
+            for _item_transactions in self.transactions:
+                if _item_transactions:
+                    _items.append(_item_transactions.to_dict())
+            _dict['transactions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Investment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "itemId": obj.get("itemId"),
+            "type": obj.get("type"),
+            "subtype": obj.get("subtype"),
+            "number": obj.get("number"),
+            "balance": obj.get("balance"),
+            "name": obj.get("name"),
+            "lastMonthRate": obj.get("lastMonthRate"),
+            "lastTwelveMonthsRate": obj.get("lastTwelveMonthsRate"),
+            "annualRate": obj.get("annualRate"),
+            "currencyCode": obj.get("currencyCode"),
+            "code": obj.get("code"),
+            "isin": obj.get("isin"),
+            "value": obj.get("value"),
+            "quantity": obj.get("quantity"),
+            "amount": obj.get("amount"),
+            "taxes": obj.get("taxes"),
+            "taxes2": obj.get("taxes2"),
+            "date": obj.get("date"),
+            "owner": obj.get("owner"),
+            "amountProfit": obj.get("amountProfit"),
+            "amountWithdrawal": obj.get("amountWithdrawal"),
+            "amountOriginal": obj.get("amountOriginal"),
+            "metadata": InvestmentMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None,
+            "transactions": [InvestmentTransaction.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None,
+            "dueDate": obj.get("dueDate"),
+            "issuer": obj.get("issuer"),
+            "issuerCNPJ": obj.get("issuerCNPJ"),
+            "issueDate": obj.get("issueDate"),
+            "rate": obj.get("rate"),
+            "rateType": obj.get("rateType"),
+            "fixedAnnualRate": obj.get("fixedAnnualRate"),
+            "status": obj.get("status")
+        })
+        return _obj
+
+

pluggy_sdk/models/investment_expenses.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class InvestmentExpenses(BaseModel):
+    """
+    Taxes and fees that applied to the transaction
+    """ # noqa: E501
+    service_tax: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="(ISS) Service tax that varies according to state", alias="serviceTax")
+    brokerage_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Commission charged by the brokerage for carrying out transactions on the stock market", alias="brokerageFee")
+    income_tax: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="(IRRF) Income Tax Withholding, amount paid to the Internal Revenue Service", alias="incomeTax")
+    trading_assets_notice_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="(ANA) Fee of Notice of Trading in Assets", alias="tradingAssetsNoticeFee")
+    maintenance_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="(termo/opções) Fees charged by BM&F Bovespa in negotiations", alias="maintenanceFee")
+    settlement_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Liquidation fee for the settlement of a position on the expiration date or the financial settlement of physical delivery", alias="settlementFee")
+    clearing_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Registration fee", alias="clearingFee")
+    stock_exchange_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="(Emolumentos) Fees charged by BM&F Bovespa as a source of operating income", alias="stockExchangeFee")
+    custody_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Fee by brokers to keep recordsin their home broker systems or on the trading desk", alias="custodyFee")
+    operating_fee: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Amount paid to the Operator for the intermediation service", alias="operatingFee")
+    other: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Sum of other not defined expenses")
+    __properties: ClassVar[List[str]] = ["serviceTax", "brokerageFee", "incomeTax", "tradingAssetsNoticeFee", "maintenanceFee", "settlementFee", "clearingFee", "stockExchangeFee", "custodyFee", "operatingFee", "other"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of InvestmentExpenses from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InvestmentExpenses from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "serviceTax": obj.get("serviceTax"),
+            "brokerageFee": obj.get("brokerageFee"),
+            "incomeTax": obj.get("incomeTax"),
+            "tradingAssetsNoticeFee": obj.get("tradingAssetsNoticeFee"),
+            "maintenanceFee": obj.get("maintenanceFee"),
+            "settlementFee": obj.get("settlementFee"),
+            "clearingFee": obj.get("clearingFee"),
+            "stockExchangeFee": obj.get("stockExchangeFee"),
+            "custodyFee": obj.get("custodyFee"),
+            "operatingFee": obj.get("operatingFee"),
+            "other": obj.get("other")
+        })
+        return _obj
+
+

pluggy_sdk/models/investment_metadata.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pluggy_sdk.models.company import Company
+from typing import Optional, Set
+from typing_extensions import Self
+
+class InvestmentMetadata(BaseModel):
+    """
+    Investment metadata for Previdencia migrations
+    """ # noqa: E501
+    tax_regime: Optional[StrictStr] = Field(default=None, description="Description of the type of tax applied to previdencia", alias="taxRegime")
+    proposal_number: Optional[StrictStr] = Field(default=None, description="Previdencial proposal number", alias="proposalNumber")
+    process_number: Optional[StrictStr] = Field(default=None, description="Number of the process of a previdencia", alias="processNumber")
+    fund_name: Optional[StrictStr] = Field(default=None, description="Name of the fund associated with the previdencia.", alias="fundName")
+    insurer: Optional[Company] = Field(default=None, description="Insurer of the Security Investment")
+    __properties: ClassVar[List[str]] = ["taxRegime", "proposalNumber", "processNumber", "fundName", "insurer"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of InvestmentMetadata from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of insurer
+        if self.insurer:
+            _dict['insurer'] = self.insurer.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InvestmentMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "taxRegime": obj.get("taxRegime"),
+            "proposalNumber": obj.get("proposalNumber"),
+            "processNumber": obj.get("processNumber"),
+            "fundName": obj.get("fundName"),
+            "insurer": Company.from_dict(obj["insurer"]) if obj.get("insurer") is not None else None
+        })
+        return _obj
+
+