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

pluggy_sdk/models/document.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Document(BaseModel):
+    """
+    Document object containing type & value
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description="Type of document")
+    value: Optional[StrictStr] = Field(default=None, description="Formatted value of the document")
+    __properties: ClassVar[List[str]] = ["type", "value"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['CPF', 'CNPJ']):
+            raise ValueError("must be one of enum values ('CPF', 'CNPJ')")
+        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 Document 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 Document 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"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

pluggy_sdk/models/email.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Email(BaseModel):
+    """
+    The email object contains emails associated with the owner of the account
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    value: StrictStr = Field(description="The full email of the person.")
+    __properties: ClassVar[List[str]] = ["type", "value"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Personal', 'Work']):
+            raise ValueError("must be one of enum values ('Personal', 'Work')")
+        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 Email 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 Email 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"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

pluggy_sdk/models/global_error_response.py

@@ -0,0 +1,94 @@
+# 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 GlobalErrorResponse(BaseModel):
+    """
+    GlobalErrorResponse
+    """ # noqa: E501
+    code: Union[StrictFloat, StrictInt]
+    message: StrictStr
+    code_description: Optional[StrictStr] = Field(default=None, description="Distinctive code description, useful to distinguish the error.", alias="codeDescription")
+    data: Optional[Dict[str, Any]] = Field(default=None, description="Additional data related to the error, if any")
+    __properties: ClassVar[List[str]] = ["code", "message", "codeDescription", "data"]
+
+    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 GlobalErrorResponse 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 GlobalErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "code": obj.get("code"),
+            "message": obj.get("message"),
+            "codeDescription": obj.get("codeDescription"),
+            "data": obj.get("data")
+        })
+        return _obj
+
+

pluggy_sdk/models/i_count_response.py

@@ -0,0 +1,88 @@
+# 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 ICountResponse(BaseModel):
+    """
+    Deletion response
+    """ # noqa: E501
+    count: Union[StrictFloat, StrictInt] = Field(description="Amount of items deleted")
+    __properties: ClassVar[List[str]] = ["count"]
+
+    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 ICountResponse 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 ICountResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "count": obj.get("count")
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_relation.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityRelation(BaseModel):
+    """
+    The relation object contains name and relation to the owner of the account
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description="Type of relation: Father, Mother or Spouse")
+    name: Optional[StrictStr] = Field(default=None, description="The full name of the person")
+    document: Optional[StrictStr] = Field(default=None, description="Primary document of the person")
+    __properties: ClassVar[List[str]] = ["type", "name", "document"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Mother', 'Father', 'Spouse']):
+            raise ValueError("must be one of enum values ('Mother', 'Father', 'Spouse')")
+        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 IdentityRelation 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 IdentityRelation 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"),
+            "name": obj.get("name"),
+            "document": obj.get("document")
+        })
+        return _obj
+
+

pluggy_sdk/models/identity_response.py

@@ -0,0 +1,173 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from pluggy_sdk.models.address import Address
+from pluggy_sdk.models.email import Email
+from pluggy_sdk.models.identity_relation import IdentityRelation
+from pluggy_sdk.models.identity_response_financial_relationships import IdentityResponseFinancialRelationships
+from pluggy_sdk.models.identity_response_qualifications import IdentityResponseQualifications
+from pluggy_sdk.models.phone_number import PhoneNumber
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IdentityResponse(BaseModel):
+    """
+    Response with details personal information related to the owner of the connection's account
+    """ # noqa: E501
+    id: StrictStr = Field(description="The ID of the identity to retrieve")
+    item_id: StrictStr = Field(description="Identifier of the item linked to the identity", alias="itemId")
+    birth_date: Optional[datetime] = Field(default=None, description="Date of birth", alias="birthDate")
+    tax_number: Optional[StrictStr] = Field(default=None, description="The tax ID (CNPJ) associated with the business account", alias="taxNumber")
+    document: Optional[StrictStr] = Field(default=None, description="Primary document that identifies the owner")
+    document_type: Optional[StrictStr] = Field(default=None, description="Type of document collected", alias="documentType")
+    job_title: Optional[StrictStr] = Field(default=None, description="Profession or Job information", alias="jobTitle")
+    full_name: Optional[StrictStr] = Field(default=None, description="Name of the owner of the account", alias="fullName")
+    establishment_code: Optional[StrictStr] = Field(default=None, description="Establishment code (only for PAYMENT_ACCOUNT connectors)", alias="establishmentCode")
+    establishment_name: Optional[StrictStr] = Field(default=None, description="Name of the establishment (only for PAYMENT_ACCOUNT connectors)", alias="establishmentName")
+    company_name: Optional[StrictStr] = Field(default=None, description="For business connector, the name of the business", alias="companyName")
+    phone_numbers: Optional[List[PhoneNumber]] = Field(default=None, description="List of phone numbers related to the account", alias="phoneNumbers")
+    emails: Optional[List[Email]] = Field(default=None, description="List of email addresses related to the account")
+    addresses: Optional[List[Address]] = Field(default=None, description="List of addresses related to the account")
+    relations: Optional[List[IdentityRelation]] = Field(default=None, description="List of names related to the account")
+    investor_profile: Optional[StrictStr] = Field(default=None, description="Is a rating that indicates the investor personality and motivation for investing", alias="investorProfile")
+    qualifications: Optional[IdentityResponseQualifications] = None
+    financial_relationships: Optional[IdentityResponseFinancialRelationships] = Field(default=None, alias="financialRelationships")
+    __properties: ClassVar[List[str]] = ["id", "itemId", "birthDate", "taxNumber", "document", "documentType", "jobTitle", "fullName", "establishmentCode", "establishmentName", "companyName", "phoneNumbers", "emails", "addresses", "relations", "investorProfile", "qualifications", "financialRelationships"]
+
+    @field_validator('investor_profile')
+    def investor_profile_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Conservative', 'Moderate', 'Aggressive']):
+            raise ValueError("must be one of enum values ('Conservative', 'Moderate', 'Aggressive')")
+        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 IdentityResponse 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 phone_numbers (list)
+        _items = []
+        if self.phone_numbers:
+            for _item_phone_numbers in self.phone_numbers:
+                if _item_phone_numbers:
+                    _items.append(_item_phone_numbers.to_dict())
+            _dict['phoneNumbers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in emails (list)
+        _items = []
+        if self.emails:
+            for _item_emails in self.emails:
+                if _item_emails:
+                    _items.append(_item_emails.to_dict())
+            _dict['emails'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in addresses (list)
+        _items = []
+        if self.addresses:
+            for _item_addresses in self.addresses:
+                if _item_addresses:
+                    _items.append(_item_addresses.to_dict())
+            _dict['addresses'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in relations (list)
+        _items = []
+        if self.relations:
+            for _item_relations in self.relations:
+                if _item_relations:
+                    _items.append(_item_relations.to_dict())
+            _dict['relations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of qualifications
+        if self.qualifications:
+            _dict['qualifications'] = self.qualifications.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of financial_relationships
+        if self.financial_relationships:
+            _dict['financialRelationships'] = self.financial_relationships.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IdentityResponse 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"),
+            "birthDate": obj.get("birthDate"),
+            "taxNumber": obj.get("taxNumber"),
+            "document": obj.get("document"),
+            "documentType": obj.get("documentType"),
+            "jobTitle": obj.get("jobTitle"),
+            "fullName": obj.get("fullName"),
+            "establishmentCode": obj.get("establishmentCode"),
+            "establishmentName": obj.get("establishmentName"),
+            "companyName": obj.get("companyName"),
+            "phoneNumbers": [PhoneNumber.from_dict(_item) for _item in obj["phoneNumbers"]] if obj.get("phoneNumbers") is not None else None,
+            "emails": [Email.from_dict(_item) for _item in obj["emails"]] if obj.get("emails") is not None else None,
+            "addresses": [Address.from_dict(_item) for _item in obj["addresses"]] if obj.get("addresses") is not None else None,
+            "relations": [IdentityRelation.from_dict(_item) for _item in obj["relations"]] if obj.get("relations") is not None else None,
+            "investorProfile": obj.get("investorProfile"),
+            "qualifications": IdentityResponseQualifications.from_dict(obj["qualifications"]) if obj.get("qualifications") is not None else None,
+            "financialRelationships": IdentityResponseFinancialRelationships.from_dict(obj["financialRelationships"]) if obj.get("financialRelationships") is not None else None
+        })
+        return _obj
+
+