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

pluggy_sdk/models/status_detail_product_warning.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class StatusDetailProductWarning(BaseModel):
+    """
+    StatusDetailProductWarning
+    """ # noqa: E501
+    code: StrictStr = Field(description="The warning code generated by Pluggy")
+    message: StrictStr = Field(description="The warning message in english generated by Pluggy")
+    provider_message: Optional[StrictStr] = Field(default=None, description="The warning message from the FI if provided", alias="providerMessage")
+    __properties: ClassVar[List[str]] = ["code", "message", "providerMessage"]
+
+    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 StatusDetailProductWarning 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 StatusDetailProductWarning 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"),
+            "providerMessage": obj.get("providerMessage")
+        })
+        return _obj
+
+

pluggy_sdk/models/transaction.py

@@ -0,0 +1,145 @@
+# 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.acquirer_data import AcquirerData
+from pluggy_sdk.models.credit_card_metadata import CreditCardMetadata
+from pluggy_sdk.models.merchant import Merchant
+from pluggy_sdk.models.payment_data import PaymentData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Transaction(BaseModel):
+    """
+    Transaction product
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier of the transaction")
+    description: StrictStr = Field(description="Clean description of the transaction")
+    currency_code: StrictStr = Field(description="Currency ISO code", alias="currencyCode")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Transaction amount")
+    amount_in_account_currency: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Transaction amount in Account's Currency. Only present if the transaction is in a different currency than the account's currency", alias="amountInAccountCurrency")
+    var_date: datetime = Field(description="Date when the transaction was made", alias="date")
+    type: Optional[StrictStr] = Field(default=None, description="Type of the transaction. DEBIT (outflow) or CREDIT (inflow)")
+    balance: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Balance after the transaction")
+    provider_code: Optional[StrictStr] = Field(default=None, description="Institution provided code", alias="providerCode")
+    status: Optional[StrictStr] = Field(default=None, description="Status of the movement. POSTED / PENDING")
+    category: Optional[StrictStr] = Field(default=None, description="Category of the transaction (e.g. Restaurants, Education). See the Transaction Categorization section in our guides.")
+    category_id: Optional[StrictStr] = Field(default=None, description="Id of the transaction category. Can be used to identify the category in the Categories endpoint", alias="categoryId")
+    payment_data: Optional[PaymentData] = Field(default=None, alias="paymentData")
+    acquirer_data: Optional[AcquirerData] = Field(default=None, alias="acquirerData")
+    credit_card_metadata: Optional[CreditCardMetadata] = Field(default=None, alias="creditCardMetadata")
+    merchant: Optional[Merchant] = None
+    __properties: ClassVar[List[str]] = ["id", "description", "currencyCode", "amount", "amountInAccountCurrency", "date", "type", "balance", "providerCode", "status", "category", "categoryId", "paymentData", "acquirerData", "creditCardMetadata", "merchant"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEBIT', 'CREDIT']):
+            raise ValueError("must be one of enum values ('DEBIT', 'CREDIT')")
+        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 Transaction 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 payment_data
+        if self.payment_data:
+            _dict['paymentData'] = self.payment_data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of acquirer_data
+        if self.acquirer_data:
+            _dict['acquirerData'] = self.acquirer_data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of credit_card_metadata
+        if self.credit_card_metadata:
+            _dict['creditCardMetadata'] = self.credit_card_metadata.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of merchant
+        if self.merchant:
+            _dict['merchant'] = self.merchant.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Transaction 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"),
+            "description": obj.get("description"),
+            "currencyCode": obj.get("currencyCode"),
+            "amount": obj.get("amount"),
+            "amountInAccountCurrency": obj.get("amountInAccountCurrency"),
+            "date": obj.get("date"),
+            "type": obj.get("type"),
+            "balance": obj.get("balance"),
+            "providerCode": obj.get("providerCode"),
+            "status": obj.get("status"),
+            "category": obj.get("category"),
+            "categoryId": obj.get("categoryId"),
+            "paymentData": PaymentData.from_dict(obj["paymentData"]) if obj.get("paymentData") is not None else None,
+            "acquirerData": AcquirerData.from_dict(obj["acquirerData"]) if obj.get("acquirerData") is not None else None,
+            "creditCardMetadata": CreditCardMetadata.from_dict(obj["creditCardMetadata"]) if obj.get("creditCardMetadata") is not None else None,
+            "merchant": Merchant.from_dict(obj["merchant"]) if obj.get("merchant") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/update_item.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 pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from pluggy_sdk.models.update_item_parameters import UpdateItemParameters
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateItem(BaseModel):
+    """
+    Update Item Request
+    """ # noqa: E501
+    parameters: Optional[UpdateItemParameters] = None
+    client_user_id: Optional[StrictStr] = Field(default=None, description="Client's identifier for the user, it can be a ID, UUID or even an email.", alias="clientUserId")
+    webhook_url: Optional[StrictStr] = Field(default=None, description="Url to be notified of item changes", alias="webhookUrl")
+    products: Optional[List[StrictStr]] = Field(default=None, description="Products to be collected in the connection")
+    __properties: ClassVar[List[str]] = ["parameters", "clientUserId", "webhookUrl", "products"]
+
+    @field_validator('products')
+    def products_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['ACCOUNTS', 'TRANSACTIONS', 'CREDIT_CARDS', 'INVESTMENTS', 'INVESTMENTS_TRANSACTIONS', 'PAYMENT_DATA', 'IDENTITY', 'BROKERAGE_NOTE', 'OPPORTUNITIES', 'PORTFOLIO', 'INCOME_REPORTS']):
+                raise ValueError("each list item must be one of ('ACCOUNTS', 'TRANSACTIONS', 'CREDIT_CARDS', 'INVESTMENTS', 'INVESTMENTS_TRANSACTIONS', 'PAYMENT_DATA', 'IDENTITY', 'BROKERAGE_NOTE', 'OPPORTUNITIES', 'PORTFOLIO', 'INCOME_REPORTS')")
+        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 UpdateItem 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 parameters
+        if self.parameters:
+            _dict['parameters'] = self.parameters.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameters": UpdateItemParameters.from_dict(obj["parameters"]) if obj.get("parameters") is not None else None,
+            "clientUserId": obj.get("clientUserId"),
+            "webhookUrl": obj.get("webhookUrl"),
+            "products": obj.get("products")
+        })
+        return _obj
+
+

pluggy_sdk/models/update_item_parameters.py

@@ -0,0 +1,144 @@
+# 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 json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, Dict, List, Optional
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+UPDATEITEMPARAMETERS_ONE_OF_SCHEMAS = ["object", "str"]
+
+class UpdateItemParameters(BaseModel):
+    """
+    Parameters to update on the item stored credentials.
+    """
+    # data type: object
+    oneof_schema_1_validator: Optional[Dict[str, Any]] = None
+    # data type: str
+    oneof_schema_2_validator: Optional[StrictStr] = None
+    actual_instance: Optional[Union[object, str]] = None
+    one_of_schemas: Set[str] = { "object", "str" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = UpdateItemParameters.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: object
+        try:
+            instance.oneof_schema_1_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: str
+        try:
+            instance.oneof_schema_2_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in UpdateItemParameters with oneOf schemas: object, str. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in UpdateItemParameters with oneOf schemas: object, str. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into object
+        try:
+            # validation
+            instance.oneof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.oneof_schema_1_validator
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into str
+        try:
+            # validation
+            instance.oneof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.oneof_schema_2_validator
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into UpdateItemParameters with oneOf schemas: object, str. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into UpdateItemParameters with oneOf schemas: object, str. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], object, str]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

pluggy_sdk/models/update_payment_recipient.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pluggy_sdk.models.payment_recipient_account import PaymentRecipientAccount
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdatePaymentRecipient(BaseModel):
+    """
+    Request with information to update a payment recipient
+    """ # noqa: E501
+    tax_number: Optional[StrictStr] = Field(default=None, description="Account owner tax number. Can be CPF or CNPJ (only numbers)", alias="taxNumber")
+    name: Optional[StrictStr] = Field(default=None, description="Account owner name")
+    payment_institution_id: Optional[StrictStr] = Field(default=None, description="Primary identifier of the institution associated to the payment recipient", alias="paymentInstitutionId")
+    account: Optional[PaymentRecipientAccount] = None
+    is_default: Optional[StrictBool] = Field(default=None, description="Indicates if the recipient is the default one", alias="isDefault")
+    __properties: ClassVar[List[str]] = ["taxNumber", "name", "paymentInstitutionId", "account", "isDefault"]
+
+    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 UpdatePaymentRecipient 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 account
+        if self.account:
+            _dict['account'] = self.account.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdatePaymentRecipient 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"),
+            "paymentInstitutionId": obj.get("paymentInstitutionId"),
+            "account": PaymentRecipientAccount.from_dict(obj["account"]) if obj.get("account") is not None else None,
+            "isDefault": obj.get("isDefault")
+        })
+        return _obj
+
+