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

pluggy_sdk/models/single.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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SINGLE(BaseModel):
+    """
+    Schedule atribute to generate one payment in the future
+    """ # noqa: E501
+    type: StrictStr = Field(description="Scheduled type")
+    var_date: date = Field(alias="date")
+    __properties: ClassVar[List[str]] = ["type", "date"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['SINGLE']):
+            raise ValueError("must be one of enum values ('SINGLE')")
+        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 SINGLE 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 SINGLE 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"),
+            "date": obj.get("date")
+        })
+        return _obj
+
+

pluggy_sdk/models/smart_account.py

@@ -0,0 +1,107 @@
+# 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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SmartAccount(BaseModel):
+    """
+    Smart account product
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier of the Smart account")
+    ispb: StrictStr = Field(description="Smart account ISP number")
+    agency: StrictStr = Field(description="Smart account agency number")
+    number: StrictStr = Field(description="Smart account number")
+    verifying_digit: StrictStr = Field(description="Smart account verifying digit", alias="verifyingDigit")
+    type: StrictStr = Field(description="Smart account type")
+    is_sandbox: StrictBool = Field(description="Indicates if the smart account is a sandbox account", alias="isSandbox")
+    __properties: ClassVar[List[str]] = ["id", "ispb", "agency", "number", "verifyingDigit", "type", "isSandbox"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['CHECKING_ACCOUNT']):
+            raise ValueError("must be one of enum values ('CHECKING_ACCOUNT')")
+        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 SmartAccount 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 SmartAccount 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"),
+            "ispb": obj.get("ispb"),
+            "agency": obj.get("agency"),
+            "number": obj.get("number"),
+            "verifyingDigit": obj.get("verifyingDigit"),
+            "type": obj.get("type"),
+            "isSandbox": obj.get("isSandbox")
+        })
+        return _obj
+
+

pluggy_sdk/models/smart_account_address.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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SmartAccountAddress(BaseModel):
+    """
+    Smart account owner address
+    """ # noqa: E501
+    address_type: Optional[StrictStr] = Field(default=None, description="Owner address type", alias="addressType")
+    postal_code: Optional[StrictStr] = Field(default=None, description="Owner address postal code", alias="postalCode")
+    street_name: Optional[StrictStr] = Field(default=None, description="Owner address street name", alias="streetName")
+    street_number: Optional[StrictStr] = Field(default=None, description="Owner address street number", alias="streetNumber")
+    city: StrictStr = Field(description="Owner address city")
+    state: Optional[StrictStr] = Field(default=None, description="Owner address state")
+    is_primary_address: Optional[StrictBool] = Field(default=None, description="Indicates if the owner address is the primary one", alias="isPrimaryAddress")
+    is_mailing_address: Optional[StrictBool] = Field(default=None, description="Indicates if the owner address is the mailing one", alias="isMailingAddress")
+    __properties: ClassVar[List[str]] = ["addressType", "postalCode", "streetName", "streetNumber", "city", "state", "isPrimaryAddress", "isMailingAddress"]
+
+    @field_validator('address_type')
+    def address_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['residential', 'commercial']):
+            raise ValueError("must be one of enum values ('residential', 'commercial')")
+        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 SmartAccountAddress 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 SmartAccountAddress from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "addressType": obj.get("addressType"),
+            "postalCode": obj.get("postalCode"),
+            "streetName": obj.get("streetName"),
+            "streetNumber": obj.get("streetNumber"),
+            "city": obj.get("city"),
+            "state": obj.get("state"),
+            "isPrimaryAddress": obj.get("isPrimaryAddress"),
+            "isMailingAddress": obj.get("isMailingAddress")
+        })
+        return _obj
+
+

pluggy_sdk/models/smart_account_balance.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SmartAccountBalance(BaseModel):
+    """
+    Smart account balance product
+    """ # noqa: E501
+    last_updated_at: datetime = Field(description="Balance date", alias="lastUpdatedAt")
+    balance: Union[StrictFloat, StrictInt] = Field(description="Smart account balance amount")
+    blocked_balance: Union[StrictFloat, StrictInt] = Field(description="Smart account blocked balance amount", alias="blockedBalance")
+    scheduled_balance: Union[StrictFloat, StrictInt] = Field(description="Smart account scheduled balance amount", alias="scheduledBalance")
+    __properties: ClassVar[List[str]] = ["lastUpdatedAt", "balance", "blockedBalance", "scheduledBalance"]
+
+    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 SmartAccountBalance 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 SmartAccountBalance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "lastUpdatedAt": obj.get("lastUpdatedAt"),
+            "balance": obj.get("balance"),
+            "blockedBalance": obj.get("blockedBalance"),
+            "scheduledBalance": obj.get("scheduledBalance")
+        })
+        return _obj
+
+

pluggy_sdk/models/smart_account_transfer.py

@@ -0,0 +1,123 @@
+# 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.payment_recipient import PaymentRecipient
+from pluggy_sdk.models.smart_account import SmartAccount
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SmartAccountTransfer(BaseModel):
+    """
+    Transfer made with money from a smart account
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="Primary identifier of the transfer")
+    client_id: Optional[StrictStr] = Field(default=None, description="Primary identifier of the client associated to the transfer", alias="clientId")
+    client_payment_id: Optional[StrictStr] = Field(default=None, description="Primary identifier of the client payment associated to the transfer", alias="clientPaymentId")
+    amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Transfer amount")
+    status: Optional[StrictStr] = Field(default=None, description="Transfer status")
+    created_at: Optional[datetime] = Field(default=None, description="Transfer creation date", alias="createdAt")
+    updated_at: Optional[datetime] = Field(default=None, description="Transfer last update date", alias="updatedAt")
+    smart_account: Optional[SmartAccount] = Field(default=None, alias="smartAccount")
+    payment_recipient: Optional[PaymentRecipient] = Field(default=None, alias="paymentRecipient")
+    __properties: ClassVar[List[str]] = ["id", "clientId", "clientPaymentId", "amount", "status", "createdAt", "updatedAt", "smartAccount", "paymentRecipient"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['IN_PROGRESS', 'COMPLETED', 'ERROR']):
+            raise ValueError("must be one of enum values ('IN_PROGRESS', 'COMPLETED', 'ERROR')")
+        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 SmartAccountTransfer 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 smart_account
+        if self.smart_account:
+            _dict['smartAccount'] = self.smart_account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of payment_recipient
+        if self.payment_recipient:
+            _dict['paymentRecipient'] = self.payment_recipient.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SmartAccountTransfer 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"),
+            "clientId": obj.get("clientId"),
+            "clientPaymentId": obj.get("clientPaymentId"),
+            "amount": obj.get("amount"),
+            "status": obj.get("status"),
+            "createdAt": obj.get("createdAt"),
+            "updatedAt": obj.get("updatedAt"),
+            "smartAccount": SmartAccount.from_dict(obj["smartAccount"]) if obj.get("smartAccount") is not None else None,
+            "paymentRecipient": PaymentRecipient.from_dict(obj["paymentRecipient"]) if obj.get("paymentRecipient") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/smart_accounts_list200_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.smart_account import SmartAccount
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SmartAccountsList200Response(BaseModel):
+    """
+    SmartAccountsList200Response
+    """ # 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[SmartAccount]] = Field(default=None, description="List of smart accounts")
+    __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 SmartAccountsList200Response 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 SmartAccountsList200Response 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": [SmartAccount.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None
+        })
+        return _obj
+
+