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

pluggy_sdk/models/bill.py

@@ -0,0 +1,109 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pluggy_sdk.models.bill_finance_charge import BillFinanceCharge
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Bill(BaseModel):
+    """
+    Response with information related to a credit card bill
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier")
+    due_date: datetime = Field(description="Due date of the bill, displayed for payment by the customer", alias="dueDate")
+    total_amount: Union[StrictFloat, StrictInt] = Field(description="Total bill amount", alias="totalAmount")
+    total_amount_currency_code: StrictStr = Field(description="Code referencing the currency of the bill", alias="totalAmountCurrencyCode")
+    minimum_payment_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Minimum payment amount of the bill", alias="minimumPaymentAmount")
+    allows_installments: Optional[StrictBool] = Field(default=None, description="Indicates whether the bill allows installment payments (true) or not (false)", alias="allowsInstallments")
+    finance_charges: List[BillFinanceCharge] = Field(description="List of charges associated to the bill", alias="financeCharges")
+    __properties: ClassVar[List[str]] = ["id", "dueDate", "totalAmount", "totalAmountCurrencyCode", "minimumPaymentAmount", "allowsInstallments", "financeCharges"]
+
+    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 Bill 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 finance_charges (list)
+        _items = []
+        if self.finance_charges:
+            for _item_finance_charges in self.finance_charges:
+                if _item_finance_charges:
+                    _items.append(_item_finance_charges.to_dict())
+            _dict['financeCharges'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Bill 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"),
+            "dueDate": obj.get("dueDate"),
+            "totalAmount": obj.get("totalAmount"),
+            "totalAmountCurrencyCode": obj.get("totalAmountCurrencyCode"),
+            "minimumPaymentAmount": obj.get("minimumPaymentAmount"),
+            "allowsInstallments": obj.get("allowsInstallments"),
+            "financeCharges": [BillFinanceCharge.from_dict(_item) for _item in obj["financeCharges"]] if obj.get("financeCharges") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/bill_finance_charge.py

@@ -0,0 +1,103 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BillFinanceCharge(BaseModel):
+    """
+    Response with information related to a credit card bill finance charge
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier")
+    type: StrictStr = Field(description="Denomination of the charges that apply to the postpaid payment account bill")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Amount charged for the charge/fee")
+    currency_code: StrictStr = Field(description="Code referencing the currency of the charge", alias="currencyCode")
+    additional_info: Optional[StrictStr] = Field(default=None, description="Free field, mandatory to fill if 'OTHER' type of charge is selected", alias="additionalInfo")
+    __properties: ClassVar[List[str]] = ["id", "type", "amount", "currencyCode", "additionalInfo"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['LATE_PAYMENT_REMUNERATIVE_INTEREST', 'LATE_PAYMENT_FEE', 'LATE_PAYMENT_INTEREST', 'IOF', 'OTHER']):
+            raise ValueError("must be one of enum values ('LATE_PAYMENT_REMUNERATIVE_INTEREST', 'LATE_PAYMENT_FEE', 'LATE_PAYMENT_INTEREST', 'IOF', 'OTHER')")
+        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 BillFinanceCharge 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 BillFinanceCharge 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"),
+            "type": obj.get("type"),
+            "amount": obj.get("amount"),
+            "currencyCode": obj.get("currencyCode"),
+            "additionalInfo": obj.get("additionalInfo")
+        })
+        return _obj
+
+

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

pluggy_sdk/models/boleto.py

@@ -0,0 +1,121 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pluggy_sdk.models.boleto_payer import BoletoPayer
+from pluggy_sdk.models.boleto_recipient import BoletoRecipient
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Boleto(BaseModel):
+    """
+    Boleto data
+    """ # noqa: E501
+    digitable_line: StrictStr = Field(description="Boleto digitable line", alias="digitableLine")
+    barcode: StrictStr = Field(description="Boleto barcode")
+    payer: BoletoPayer
+    recipient: BoletoRecipient
+    var_date: datetime = Field(description="Boleto issue date", alias="date")
+    due_date: Optional[datetime] = Field(default=None, description="Boleto due date", alias="dueDate")
+    expiration_date: datetime = Field(description="After this date, the boleto cannot be paid", alias="expirationDate")
+    base_amount: Union[StrictFloat, StrictInt] = Field(description="Boleto original amount, without interests, penalties and discounts", alias="baseAmount")
+    penalty_amount: Union[StrictFloat, StrictInt] = Field(description="Boleto penalty amount. If there is no penalty, it will be returned as zero", alias="penaltyAmount")
+    interest_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Boleto interest amount. If there is no interest, it will be returned as zero", alias="interestAmount")
+    discount_amount: Union[StrictFloat, StrictInt] = Field(description="Boleto discount amount. If there is no discounts, it will be returned as zero", alias="discountAmount")
+    total_amount: Union[StrictFloat, StrictInt] = Field(description="Boleto final amount. It is equal to the base amount plus penalties and interests, minus discounts", alias="totalAmount")
+    updated_at: Optional[datetime] = Field(default=None, description="Date when the lastest information of this boleto has been retrieved", alias="updatedAt")
+    __properties: ClassVar[List[str]] = ["digitableLine", "barcode", "payer", "recipient", "date", "dueDate", "expirationDate", "baseAmount", "penaltyAmount", "interestAmount", "discountAmount", "totalAmount", "updatedAt"]
+
+    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 Boleto 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 payer
+        if self.payer:
+            _dict['payer'] = self.payer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of recipient
+        if self.recipient:
+            _dict['recipient'] = self.recipient.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Boleto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "digitableLine": obj.get("digitableLine"),
+            "barcode": obj.get("barcode"),
+            "payer": BoletoPayer.from_dict(obj["payer"]) if obj.get("payer") is not None else None,
+            "recipient": BoletoRecipient.from_dict(obj["recipient"]) if obj.get("recipient") is not None else None,
+            "date": obj.get("date"),
+            "dueDate": obj.get("dueDate"),
+            "expirationDate": obj.get("expirationDate"),
+            "baseAmount": obj.get("baseAmount"),
+            "penaltyAmount": obj.get("penaltyAmount"),
+            "interestAmount": obj.get("interestAmount"),
+            "discountAmount": obj.get("discountAmount"),
+            "totalAmount": obj.get("totalAmount"),
+            "updatedAt": obj.get("updatedAt")
+        })
+        return _obj
+
+

pluggy_sdk/models/boleto_payer.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BoletoPayer(BaseModel):
+    """
+    Boleto payer information
+    """ # noqa: E501
+    tax_number: StrictStr = Field(description="Payer CPF or CNPJ", alias="taxNumber")
+    name: StrictStr = Field(description="Payer name")
+    __properties: ClassVar[List[str]] = ["taxNumber", "name"]
+
+    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 BoletoPayer 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 BoletoPayer from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "taxNumber": obj.get("taxNumber"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+

pluggy_sdk/models/boleto_recipient.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BoletoRecipient(BaseModel):
+    """
+    Boleto recipient information
+    """ # noqa: E501
+    tax_number: StrictStr = Field(description="Recipient CPF or CNPJ", alias="taxNumber")
+    name: StrictStr = Field(description="Recipient name")
+    __properties: ClassVar[List[str]] = ["taxNumber", "name"]
+
+    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 BoletoRecipient 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 BoletoRecipient from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "taxNumber": obj.get("taxNumber"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+