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

pluggy_sdk/models/identity_response_financial_relationships.py

@@ -0,0 +1,111 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pluggy_sdk.models.identity_response_financial_relationships_accounts_inner import IdentityResponseFinancialRelationshipsAccountsInner
+from pluggy_sdk.models.identity_response_financial_relationships_procurators_inner import IdentityResponseFinancialRelationshipsProcuratorsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponseFinancialRelationships(BaseModel):
+    """
+    Information that allows institutions to assess, evaluate, characterize, and classify the client with the purpose of understanding their risk profile and their economic-financial capacity
+    """ # noqa: E501
+    start_date: datetime = Field(description="Date when the relationship with the institution started", alias="startDate")
+    products_services_type: List[StrictStr] = Field(description="List of products and services that the client consumes", alias="productsServicesType")
+    procurators: List[IdentityResponseFinancialRelationshipsProcuratorsInner] = Field(description="List of procurators of the client")
+    accounts: Optional[List[IdentityResponseFinancialRelationshipsAccountsInner]] = Field(default=None, description="List of accounts of the client")
+    __properties: ClassVar[List[str]] = ["startDate", "productsServicesType", "procurators", "accounts"]
+
+    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 IdentityResponseFinancialRelationships 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 procurators (list)
+        _items = []
+        if self.procurators:
+            for _item_procurators in self.procurators:
+                if _item_procurators:
+                    _items.append(_item_procurators.to_dict())
+            _dict['procurators'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in accounts (list)
+        _items = []
+        if self.accounts:
+            for _item_accounts in self.accounts:
+                if _item_accounts:
+                    _items.append(_item_accounts.to_dict())
+            _dict['accounts'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IdentityResponseFinancialRelationships from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "startDate": obj.get("startDate"),
+            "productsServicesType": obj.get("productsServicesType"),
+            "procurators": [IdentityResponseFinancialRelationshipsProcuratorsInner.from_dict(_item) for _item in obj["procurators"]] if obj.get("procurators") is not None else None,
+            "accounts": [IdentityResponseFinancialRelationshipsAccountsInner.from_dict(_item) for _item in obj["accounts"]] if obj.get("accounts") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_response_financial_relationships_accounts_inner.py

@@ -0,0 +1,98 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponseFinancialRelationshipsAccountsInner(BaseModel):
+    """
+    IdentityResponseFinancialRelationshipsAccountsInner
+    """ # noqa: E501
+    compe_code: StrictStr = Field(description="COMPE code of the account", alias="compeCode")
+    branch_code: StrictStr = Field(description="Branch code of the account", alias="branchCode")
+    number: StrictStr = Field(description="Number of the account")
+    check_digit: StrictStr = Field(description="Check digit of the account", alias="checkDigit")
+    type: StrictStr = Field(description="Type of the account")
+    subtype: StrictStr = Field(description="Subtype of the account")
+    __properties: ClassVar[List[str]] = ["compeCode", "branchCode", "number", "checkDigit", "type", "subtype"]
+
+    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 IdentityResponseFinancialRelationshipsAccountsInner 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 IdentityResponseFinancialRelationshipsAccountsInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "compeCode": obj.get("compeCode"),
+            "branchCode": obj.get("branchCode"),
+            "number": obj.get("number"),
+            "checkDigit": obj.get("checkDigit"),
+            "type": obj.get("type"),
+            "subtype": obj.get("subtype")
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_response_financial_relationships_procurators_inner.py

@@ -0,0 +1,101 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponseFinancialRelationshipsProcuratorsInner(BaseModel):
+    """
+    IdentityResponseFinancialRelationshipsProcuratorsInner
+    """ # noqa: E501
+    type: StrictStr = Field(description="Type of relationship with the client")
+    cpf_number: StrictStr = Field(description="CPF of the procurator", alias="cpfNumber")
+    civil_name: StrictStr = Field(description="Civil name of the procurator", alias="civilName")
+    social_name: Optional[StrictStr] = Field(default=None, description="Social name of the procurator", alias="socialName")
+    __properties: ClassVar[List[str]] = ["type", "cpfNumber", "civilName", "socialName"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['REPRESENTANTE_LEGAL', 'PROCURADOR']):
+            raise ValueError("must be one of enum values ('REPRESENTANTE_LEGAL', 'PROCURADOR')")
+        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 IdentityResponseFinancialRelationshipsProcuratorsInner 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 IdentityResponseFinancialRelationshipsProcuratorsInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "cpfNumber": obj.get("cpfNumber"),
+            "civilName": obj.get("civilName"),
+            "socialName": obj.get("socialName")
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_response_qualifications.py

@@ -0,0 +1,112 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from pluggy_sdk.models.identity_response_qualifications_informed_income import IdentityResponseQualificationsInformedIncome
+from pluggy_sdk.models.identity_response_qualifications_informed_patrimony import IdentityResponseQualificationsInformedPatrimony
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponseQualifications(BaseModel):
+    """
+    Information that allows understanding since when the consulted person has been a client of the institution, as well as an indicator of the products and services they currently consume and their representatives
+    """ # noqa: E501
+    company_cnpj: StrictStr = Field(description="CNPJ of the company", alias="companyCnpj")
+    occupation_code: Optional[StrictStr] = Field(default=None, description="Occupation code", alias="occupationCode")
+    informed_income: Optional[IdentityResponseQualificationsInformedIncome] = Field(default=None, alias="informedIncome")
+    informed_patrimony: Optional[IdentityResponseQualificationsInformedPatrimony] = Field(default=None, alias="informedPatrimony")
+    __properties: ClassVar[List[str]] = ["companyCnpj", "occupationCode", "informedIncome", "informedPatrimony"]
+
+    @field_validator('occupation_code')
+    def occupation_code_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['RECEITA_FEDERAL', 'CBO', 'OUTRO']):
+            raise ValueError("must be one of enum values ('RECEITA_FEDERAL', 'CBO', 'OUTRO')")
+        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 IdentityResponseQualifications 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 informed_income
+        if self.informed_income:
+            _dict['informedIncome'] = self.informed_income.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of informed_patrimony
+        if self.informed_patrimony:
+            _dict['informedPatrimony'] = self.informed_patrimony.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IdentityResponseQualifications from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "companyCnpj": obj.get("companyCnpj"),
+            "occupationCode": obj.get("occupationCode"),
+            "informedIncome": IdentityResponseQualificationsInformedIncome.from_dict(obj["informedIncome"]) if obj.get("informedIncome") is not None else None,
+            "informedPatrimony": IdentityResponseQualificationsInformedPatrimony.from_dict(obj["informedPatrimony"]) if obj.get("informedPatrimony") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_response_qualifications_informed_income.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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponseQualificationsInformedIncome(BaseModel):
+    """
+    Informed income
+    """ # noqa: E501
+    frequency: StrictStr = Field(description="Frequency of the informed income")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the informed income")
+    var_date: datetime = Field(description="Date when the income was informed", alias="date")
+    __properties: ClassVar[List[str]] = ["frequency", "amount", "date"]
+
+    @field_validator('frequency')
+    def frequency_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['DIARIA', 'SEMANAL', 'QUINZENAL', 'MENSAL', 'BIMESTRAL', 'TRIMESTRAL', 'SEMESTRAL', 'ANUAL', 'OUTROS']):
+            raise ValueError("must be one of enum values ('DIARIA', 'SEMANAL', 'QUINZENAL', 'MENSAL', 'BIMESTRAL', 'TRIMESTRAL', 'SEMESTRAL', 'ANUAL', 'OUTROS')")
+        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 IdentityResponseQualificationsInformedIncome 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 IdentityResponseQualificationsInformedIncome from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "frequency": obj.get("frequency"),
+            "amount": obj.get("amount"),
+            "date": obj.get("date")
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_response_qualifications_informed_patrimony.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
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponseQualificationsInformedPatrimony(BaseModel):
+    """
+    Informed patrimony
+    """ # noqa: E501
+    amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the informed patrimony")
+    year: Union[StrictFloat, StrictInt] = Field(description="Year of the patrimony")
+    __properties: ClassVar[List[str]] = ["amount", "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 IdentityResponseQualificationsInformedPatrimony 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 IdentityResponseQualificationsInformedPatrimony from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "amount": obj.get("amount"),
+            "year": obj.get("year")
+        })
+        return _obj
+
+