pluggy-sdk 1.0.0.post36__py3-none-any.whl → 1.0.0.post38__py3-none-any.whl

pluggy_sdk/models/create_boleto_connection.py

@@ -0,0 +1,91 @@
+# 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_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateBoletoConnection(BaseModel):
+    """
+    Request with information to create a boleto connection
+    """ # noqa: E501
+    connector_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="Connector identifier. Check out the list of connectors, and if it has the flag 'supportsBoletoManagement' as true, it means it's possible to create a boleto connection with it.", alias="connectorId")
+    credentials: Dict[str, StrictStr] = Field(description="Credentials required for the connection. For Inter, they are clientId, clientSecret, certificate and privateKey, follow: https://docs.pluggy.ai/docs/connect-an-account#inter-pj")
+    __properties: ClassVar[List[str]] = ["connectorId", "credentials"]
+
+    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 CreateBoletoConnection 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 CreateBoletoConnection from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connectorId": obj.get("connectorId"),
+            "credentials": obj.get("credentials")
+        })
+        return _obj
+
+

pluggy_sdk/models/create_boleto_connection_from_item.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateBoletoConnectionFromItem(BaseModel):
+    """
+    Request with information to create a boleto connection from an Item
+    """ # noqa: E501
+    item_id: StrictStr = Field(description="Item ID", alias="itemId")
+    __properties: ClassVar[List[str]] = ["itemId"]
+
+    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 CreateBoletoConnectionFromItem 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 CreateBoletoConnectionFromItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "itemId": obj.get("itemId")
+        })
+        return _obj
+
+

pluggy_sdk/models/create_item.py

@@ -31,7 +31,7 @@ class CreateItem(BaseModel):
     connector_id: Union[StrictFloat, StrictInt] = Field(description="Primary identifier of the connector", alias="connectorId")
     parameters: CreateItemParameters
     webhook_url: Optional[StrictStr] = Field(default=None, description="Url to be notified of item changes", alias="webhookUrl")
-    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")
+    client_user_id: Optional[StrictStr] = Field(default=None, description="Client's external identifier for the user, it can be a ID, UUID or even an email. This is free for clients to use.", alias="clientUserId")
     oauth_redirect_uri: Optional[StrictStr] = Field(default=None, description="Redirect URI required for the Oauth flow", alias="oauthRedirectUri")
     products: Optional[List[StrictStr]] = Field(default=None, description="Products to be collected in the connection")
     avoid_duplicates: Optional[StrictBool] = Field(default=None, description="Avoids creating a new item if there is already one with the same credentials", alias="avoidDuplicates")

pluggy_sdk/models/create_or_update_payment_customer.py

@@ -30,7 +30,7 @@ class CreateOrUpdatePaymentCustomer(BaseModel):
     id: StrictStr = Field(description="Primary identifier")
     type: StrictStr = Field(description="Customer type")
     name: StrictStr = Field(description="Customer name")
-    email: StrictStr = Field(description="Customer email")
+    email: Optional[StrictStr] = Field(default=None, description="Customer email")
     cpf: Optional[StrictStr] = Field(default=None, description="Customer CPF")
     cnpj: Optional[StrictStr] = Field(default=None, description="Customer CNPJ, if type is `BUSINESS`")
     __properties: ClassVar[List[str]] = ["id", "type", "name", "email", "cpf", "cnpj"]

pluggy_sdk/models/create_payment_customer_request_body.py

@@ -29,7 +29,7 @@ class CreatePaymentCustomerRequestBody(BaseModel):
     """ # noqa: E501
     type: StrictStr = Field(description="Customer type")
     name: StrictStr = Field(description="Customer name")
-    email: StrictStr = Field(description="Customer email")
+    email: Optional[StrictStr] = Field(default=None, description="Customer email")
     cpf: Optional[StrictStr] = Field(default=None, description="Customer CPF")
     cnpj: Optional[StrictStr] = Field(default=None, description="Customer CNPJ, if type is `BUSINESS`")
     __properties: ClassVar[List[str]] = ["type", "name", "email", "cpf", "cnpj"]

pluggy_sdk/models/create_payment_recipient.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from pluggy_sdk.models.payment_recipient_account import PaymentRecipientAccount
 from typing import Optional, Set
@@ -32,10 +32,9 @@ class CreatePaymentRecipient(BaseModel):
     name: Optional[StrictStr] = Field(default=None, description="Account owner name. Send only this when the pixKey is not sent.")
     payment_institution_id: Optional[StrictStr] = Field(default=None, description="Primary identifier of the institution associated to the payment recipient. Send only when the pixKey is not sent.", alias="paymentInstitutionId")
     account: Optional[PaymentRecipientAccount] = Field(default=None, description="Recipient's bank account destination. Send only if the pixKey is not sent.")
-    is_default: Optional[StrictBool] = Field(default=None, description="Indicates if the recipient is the default one", alias="isDefault")
     pix_key: Optional[StrictStr] = Field(default=None, description="Pix key associated with the payment recipient", alias="pixKey")
     smart_account_id: Optional[StrictStr] = Field(default=None, description="Smart account identifier associated to the payment recipient, used to be able to use PIX Qr method", alias="smartAccountId")
-    __properties: ClassVar[List[str]] = ["taxNumber", "name", "paymentInstitutionId", "account", "isDefault", "pixKey", "smartAccountId"]
+    __properties: ClassVar[List[str]] = ["taxNumber", "name", "paymentInstitutionId", "account", "pixKey", "smartAccountId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -95,7 +94,6 @@ class CreatePaymentRecipient(BaseModel):
             "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"),
             "pixKey": obj.get("pixKey"),
             "smartAccountId": obj.get("smartAccountId")
         })

pluggy_sdk/models/create_webhook.py

@@ -35,8 +35,8 @@ class CreateWebhook(BaseModel):
     @field_validator('event')
     def event_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['all', 'item/created', 'item/updated', 'item/error', 'item/deleted', 'item/waiting_user_input', 'item/waiting_user_action', 'item/login_succeeded', 'connector/status_updated', 'transactions/updated', 'transactions/deleted', 'payment_intent/created', 'payment_intent/completed', 'payment_intent/waiting_payer_authorization', 'payment_intent/error', 'scheduled_payment/created', 'scheduled_payment/completed', 'scheduled_payment/error', 'scheduled_payment/canceled', 'scheduled_payment/all_completed', 'payment_refund/completed', 'payment_refund/error']):
-            raise ValueError("must be one of enum values ('all', 'item/created', 'item/updated', 'item/error', 'item/deleted', 'item/waiting_user_input', 'item/waiting_user_action', 'item/login_succeeded', 'connector/status_updated', 'transactions/updated', 'transactions/deleted', 'payment_intent/created', 'payment_intent/completed', 'payment_intent/waiting_payer_authorization', 'payment_intent/error', 'scheduled_payment/created', 'scheduled_payment/completed', 'scheduled_payment/error', 'scheduled_payment/canceled', 'scheduled_payment/all_completed', 'payment_refund/completed', 'payment_refund/error')")
+        if value not in set(['all', 'item/created', 'item/updated', 'item/error', 'item/deleted', 'item/waiting_user_input', 'item/waiting_user_action', 'item/login_succeeded', 'connector/status_updated', 'transactions/created', 'transactions/updated', 'transactions/deleted', 'payment_intent/created', 'payment_intent/completed', 'payment_intent/waiting_payer_authorization', 'payment_intent/error', 'scheduled_payment/created', 'scheduled_payment/completed', 'scheduled_payment/error', 'scheduled_payment/canceled', 'scheduled_payment/all_completed', 'payment_refund/completed', 'payment_refund/error', 'boleto/updated']):
+            raise ValueError("must be one of enum values ('all', 'item/created', 'item/updated', 'item/error', 'item/deleted', 'item/waiting_user_input', 'item/waiting_user_action', 'item/login_succeeded', 'connector/status_updated', 'transactions/created', 'transactions/updated', 'transactions/deleted', 'payment_intent/created', 'payment_intent/completed', 'payment_intent/waiting_payer_authorization', 'payment_intent/error', 'scheduled_payment/created', 'scheduled_payment/completed', 'scheduled_payment/error', 'scheduled_payment/canceled', 'scheduled_payment/all_completed', 'payment_refund/completed', 'payment_refund/error', 'boleto/updated')")
         return value
 
     model_config = ConfigDict(

pluggy_sdk/models/investment.py

@@ -22,7 +22,6 @@ 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.investment_metadata import InvestmentMetadata
-from pluggy_sdk.models.investment_transaction import InvestmentTransaction
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -54,7 +53,6 @@ class Investment(BaseModel):
     amount_withdrawal: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The amount available to withdraw", alias="amountWithdrawal")
     amount_original: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Amount originally invested", alias="amountOriginal")
     metadata: Optional[InvestmentMetadata] = Field(default=None, description="Security Portability details")
-    transactions: Optional[List[InvestmentTransaction]] = Field(default=None, description="(DEPRECATED: this field will be removed for new applications created from 21st March 2023 onward. Use the paginated `GET /investment/{id}/transactions` endpoint instead.) Transactions made on the investment (Buy, Sell, Transfer, Tax)")
     due_date: Optional[datetime] = Field(default=None, description="Expiration Date", alias="dueDate")
     issuer: Optional[StrictStr] = Field(default=None, description="The entity that issued the investment")
     issuer_cnpj: Optional[StrictStr] = Field(default=None, description="The entity CNPJ that issued the investment", alias="issuerCNPJ")
@@ -63,7 +61,7 @@ class Investment(BaseModel):
     rate_type: Optional[StrictStr] = Field(default=None, description="Type of fixed-rate", alias="rateType")
     fixed_annual_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Fixed income annual rate", alias="fixedAnnualRate")
     status: Optional[StrictStr] = Field(default=None, description="Current status of the investment enum value")
-    __properties: ClassVar[List[str]] = ["id", "itemId", "type", "subtype", "number", "balance", "name", "lastMonthRate", "lastTwelveMonthsRate", "annualRate", "currencyCode", "code", "isin", "value", "quantity", "amount", "taxes", "taxes2", "date", "owner", "amountProfit", "amountWithdrawal", "amountOriginal", "metadata", "transactions", "dueDate", "issuer", "issuerCNPJ", "issueDate", "rate", "rateType", "fixedAnnualRate", "status"]
+    __properties: ClassVar[List[str]] = ["id", "itemId", "type", "subtype", "number", "balance", "name", "lastMonthRate", "lastTwelveMonthsRate", "annualRate", "currencyCode", "code", "isin", "value", "quantity", "amount", "taxes", "taxes2", "date", "owner", "amountProfit", "amountWithdrawal", "amountOriginal", "metadata", "dueDate", "issuer", "issuerCNPJ", "issueDate", "rate", "rateType", "fixedAnnualRate", "status"]
 
     @field_validator('type')
     def type_validate_enum(cls, value):
@@ -134,13 +132,6 @@ class Investment(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of metadata
         if self.metadata:
             _dict['metadata'] = self.metadata.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of each item in transactions (list)
-        _items = []
-        if self.transactions:
-            for _item_transactions in self.transactions:
-                if _item_transactions:
-                    _items.append(_item_transactions.to_dict())
-            _dict['transactions'] = _items
         return _dict
 
     @classmethod
@@ -177,7 +168,6 @@ class Investment(BaseModel):
             "amountWithdrawal": obj.get("amountWithdrawal"),
             "amountOriginal": obj.get("amountOriginal"),
             "metadata": InvestmentMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None,
-            "transactions": [InvestmentTransaction.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None,
             "dueDate": obj.get("dueDate"),
             "issuer": obj.get("issuer"),
             "issuerCNPJ": obj.get("issuerCNPJ"),

pluggy_sdk/models/issued_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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from pluggy_sdk.models.issued_boleto_payer import IssuedBoletoPayer
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IssuedBoleto(BaseModel):
+    """
+    Response with information related to an issued boleto
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier")
+    amount: Union[Annotated[float, Field(strict=True, ge=2.5)], Annotated[int, Field(strict=True, ge=3)]] = Field(description="Boleto amount")
+    status: StrictStr = Field(description="Current status of the boleto")
+    seu_numero: Annotated[str, Field(strict=True, max_length=10)] = Field(description="Your identifier for this boleto", alias="seuNumero")
+    due_date: datetime = Field(description="Due date of the boleto", alias="dueDate")
+    payer: IssuedBoletoPayer
+    pix_qr: Optional[StrictStr] = Field(default=None, description="PIX QR code for payment", alias="pixQr")
+    digitable_line: StrictStr = Field(description="Boleto digitable line", alias="digitableLine")
+    nosso_numero: Optional[StrictStr] = Field(default=None, description="Bank's internal identifier for the boleto", alias="nossoNumero")
+    barcode: StrictStr = Field(description="Boleto barcode")
+    boleto_connection_id: StrictStr = Field(description="ID of the boleto connection used to create this boleto", alias="boletoConnectionId")
+    __properties: ClassVar[List[str]] = ["id", "amount", "status", "seuNumero", "dueDate", "payer", "pixQr", "digitableLine", "nossoNumero", "barcode", "boletoConnectionId"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['OPEN', 'PAID', 'OVERDUE', 'CANCELLED']):
+            raise ValueError("must be one of enum values ('OPEN', 'PAID', 'OVERDUE', 'CANCELLED')")
+        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 IssuedBoleto 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()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IssuedBoleto 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"),
+            "amount": obj.get("amount"),
+            "status": obj.get("status"),
+            "seuNumero": obj.get("seuNumero"),
+            "dueDate": obj.get("dueDate"),
+            "payer": IssuedBoletoPayer.from_dict(obj["payer"]) if obj.get("payer") is not None else None,
+            "pixQr": obj.get("pixQr"),
+            "digitableLine": obj.get("digitableLine"),
+            "nossoNumero": obj.get("nossoNumero"),
+            "barcode": obj.get("barcode"),
+            "boletoConnectionId": obj.get("boletoConnectionId")
+        })
+        return _obj
+
+

pluggy_sdk/models/issued_boleto_payer.py

@@ -0,0 +1,126 @@
+# 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 IssuedBoletoPayer(BaseModel):
+    """
+    IssuedBoletoPayer
+    """ # noqa: E501
+    tax_number: StrictStr = Field(description="Payer tax number (CPF/CNPJ)", alias="taxNumber")
+    person_type: Optional[StrictStr] = Field(default=None, description="Type of person (individual or business)", alias="personType")
+    name: StrictStr = Field(description="Payer name")
+    address_street: Optional[StrictStr] = Field(default=None, description="Payer street address", alias="addressStreet")
+    address_number: Optional[StrictStr] = Field(default=None, description="Payer address number", alias="addressNumber")
+    address_complement: Optional[StrictStr] = Field(default=None, description="Additional address information", alias="addressComplement")
+    address_neighborhood: Optional[StrictStr] = Field(default=None, description="Payer neighborhood", alias="addressNeighborhood")
+    address_city: Optional[StrictStr] = Field(default=None, description="Payer city", alias="addressCity")
+    address_state: StrictStr = Field(description="Payer state", alias="addressState")
+    address_zip_code: StrictStr = Field(description="Payer ZIP code", alias="addressZipCode")
+    email: Optional[StrictStr] = Field(default=None, description="Payer email")
+    ddd: Optional[StrictStr] = Field(default=None, description="Payer area code")
+    phone_number: Optional[StrictStr] = Field(default=None, description="Payer phone number", alias="phoneNumber")
+    amount_paid: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Amount paid or null if it hasn't been paid yet", alias="amountPaid")
+    payment_origin: Optional[StrictStr] = Field(default=None, description="Payment origin for the boleto", alias="paymentOrigin")
+    __properties: ClassVar[List[str]] = ["taxNumber", "personType", "name", "addressStreet", "addressNumber", "addressComplement", "addressNeighborhood", "addressCity", "addressState", "addressZipCode", "email", "ddd", "phoneNumber", "amountPaid", "paymentOrigin"]
+
+    @field_validator('payment_origin')
+    def payment_origin_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['PIX', 'BOLETO']):
+            raise ValueError("must be one of enum values ('PIX', 'BOLETO')")
+        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 IssuedBoletoPayer 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 IssuedBoletoPayer 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"),
+            "personType": obj.get("personType"),
+            "name": obj.get("name"),
+            "addressStreet": obj.get("addressStreet"),
+            "addressNumber": obj.get("addressNumber"),
+            "addressComplement": obj.get("addressComplement"),
+            "addressNeighborhood": obj.get("addressNeighborhood"),
+            "addressCity": obj.get("addressCity"),
+            "addressState": obj.get("addressState"),
+            "addressZipCode": obj.get("addressZipCode"),
+            "email": obj.get("email"),
+            "ddd": obj.get("ddd"),
+            "phoneNumber": obj.get("phoneNumber"),
+            "amountPaid": obj.get("amountPaid"),
+            "paymentOrigin": obj.get("paymentOrigin")
+        })
+        return _obj
+
+

pluggy_sdk/models/item_options.py

@@ -27,7 +27,7 @@ class ItemOptions(BaseModel):
     """
     Item options available to send through connect tokens
     """ # noqa: E501
-    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")
+    client_user_id: Optional[StrictStr] = Field(default=None, description="Client's external identifier for the user, it can be a ID, UUID or even an email. This is free for clients to use.", alias="clientUserId")
     webhook_url: Optional[StrictStr] = Field(default=None, description="Url to be notified of this specific item changes", alias="webhookUrl")
     oauth_redirect_uri: Optional[StrictStr] = Field(default=None, description="Url to redirect the user after the connect flow", alias="oauthRedirectUri")
     avoid_duplicates: Optional[StrictBool] = Field(default=None, description="Avoids creating a new item if there is already one with the same credentials", alias="avoidDuplicates")

pluggy_sdk/models/payment_intent.py

@@ -23,6 +23,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from pluggy_sdk.models.bulk_payment import BulkPayment
 from pluggy_sdk.models.connector import Connector
+from pluggy_sdk.models.payment_intent_error_detail import PaymentIntentErrorDetail
 from pluggy_sdk.models.payment_request import PaymentRequest
 from pluggy_sdk.models.pix_data import PixData
 from typing import Optional, Set
@@ -43,7 +44,8 @@ class PaymentIntent(BaseModel):
     reference_id: Optional[StrictStr] = Field(default=None, description="Pix id related to the payment intent", alias="referenceId")
     payment_method: Optional[StrictStr] = Field(default='PIS', description="Payment method can be PIS (Payment Initiation) or PIX", alias="paymentMethod")
     pix_data: Optional[PixData] = Field(default=None, description="Pix data related to the payment intent (only applies for PIX payment method)", alias="pixData")
-    __properties: ClassVar[List[str]] = ["id", "status", "createdAt", "updatedAt", "paymentRequest", "bulkPayment", "connector", "consentUrl", "referenceId", "paymentMethod", "pixData"]
+    error_detail: Optional[PaymentIntentErrorDetail] = Field(default=None, alias="errorDetail")
+    __properties: ClassVar[List[str]] = ["id", "status", "createdAt", "updatedAt", "paymentRequest", "bulkPayment", "connector", "consentUrl", "referenceId", "paymentMethod", "pixData", "errorDetail"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -116,6 +118,9 @@ class PaymentIntent(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of pix_data
         if self.pix_data:
             _dict['pixData'] = self.pix_data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of error_detail
+        if self.error_detail:
+            _dict['errorDetail'] = self.error_detail.to_dict()
         return _dict
 
     @classmethod
@@ -138,7 +143,8 @@ class PaymentIntent(BaseModel):
             "consentUrl": obj.get("consentUrl"),
             "referenceId": obj.get("referenceId"),
             "paymentMethod": obj.get("paymentMethod") if obj.get("paymentMethod") is not None else 'PIS',
-            "pixData": PixData.from_dict(obj["pixData"]) if obj.get("pixData") is not None else None
+            "pixData": PixData.from_dict(obj["pixData"]) if obj.get("pixData") is not None else None,
+            "errorDetail": PaymentIntentErrorDetail.from_dict(obj["errorDetail"]) if obj.get("errorDetail") is not None else None
         })
         return _obj