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

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_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']):
+            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')")
         return value
 
     model_config = ConfigDict(

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,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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+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")
+    __properties: ClassVar[List[str]] = ["taxNumber", "personType", "name", "addressStreet", "addressNumber", "addressComplement", "addressNeighborhood", "addressCity", "addressState", "addressZipCode", "email", "ddd", "phoneNumber"]
+
+    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")
+        })
+        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
 

pluggy_sdk/models/payment_intent_error_detail.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PaymentIntentErrorDetail(BaseModel):
+    """
+    Error details when payment intent fails
+    """ # noqa: E501
+    code: Optional[StrictStr] = Field(default=None, description="Error code")
+    provider_code: Optional[StrictStr] = Field(default=None, description="Provider error code", alias="providerCode")
+    provider_title: Optional[StrictStr] = Field(default=None, description="Provider error title", alias="providerTitle")
+    provider_detail: Optional[StrictStr] = Field(default=None, description="Provider detailed error description", alias="providerDetail")
+    __properties: ClassVar[List[str]] = ["code", "providerCode", "providerTitle", "providerDetail"]
+
+    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 PaymentIntentErrorDetail 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 PaymentIntentErrorDetail 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"),
+            "providerCode": obj.get("providerCode"),
+            "providerTitle": obj.get("providerTitle"),
+            "providerDetail": obj.get("providerDetail")
+        })
+        return _obj
+
+

pluggy_sdk/models/payment_request.py

@@ -23,6 +23,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, Stric
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from pluggy_sdk.models.boleto import Boleto
 from pluggy_sdk.models.payment_request_callback_urls import PaymentRequestCallbackUrls
+from pluggy_sdk.models.payment_request_error_detail import PaymentRequestErrorDetail
 from pluggy_sdk.models.payment_request_schedule import PaymentRequestSchedule
 from typing import Optional, Set
 from typing_extensions import Self
@@ -44,7 +45,8 @@ class PaymentRequest(BaseModel):
     pix_qr_code: Optional[StrictStr] = Field(default=None, description="Pix QR code generated by the payment receiver", alias="pixQrCode")
     boleto: Optional[Boleto] = None
     schedule: Optional[PaymentRequestSchedule] = None
-    __properties: ClassVar[List[str]] = ["id", "amount", "description", "status", "clientPaymentId", "createdAt", "updatedAt", "callbackUrls", "recipientId", "paymentUrl", "pixQrCode", "boleto", "schedule"]
+    error_detail: Optional[PaymentRequestErrorDetail] = Field(default=None, alias="errorDetail")
+    __properties: ClassVar[List[str]] = ["id", "amount", "description", "status", "clientPaymentId", "createdAt", "updatedAt", "callbackUrls", "recipientId", "paymentUrl", "pixQrCode", "boleto", "schedule", "errorDetail"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -101,6 +103,9 @@ class PaymentRequest(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of schedule
         if self.schedule:
             _dict['schedule'] = self.schedule.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
@@ -125,7 +130,8 @@ class PaymentRequest(BaseModel):
             "paymentUrl": obj.get("paymentUrl"),
             "pixQrCode": obj.get("pixQrCode"),
             "boleto": Boleto.from_dict(obj["boleto"]) if obj.get("boleto") is not None else None,
-            "schedule": PaymentRequestSchedule.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None
+            "schedule": PaymentRequestSchedule.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None,
+            "errorDetail": PaymentRequestErrorDetail.from_dict(obj["errorDetail"]) if obj.get("errorDetail") is not None else None
         })
         return _obj
 

pluggy_sdk/models/payment_request_error_detail.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PaymentRequestErrorDetail(BaseModel):
+    """
+    Error details when payment request fails
+    """ # noqa: E501
+    code: Optional[StrictStr] = Field(default=None, description="Error code")
+    provider_message: Optional[StrictStr] = Field(default=None, description="Error message returned by the institution", alias="providerMessage")
+    __properties: ClassVar[List[str]] = ["code", "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 PaymentRequestErrorDetail 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 PaymentRequestErrorDetail 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"),
+            "providerMessage": obj.get("providerMessage")
+        })
+        return _obj
+
+

pluggy_sdk/models/update_item.py

@@ -29,7 +29,7 @@ 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")
+    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 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"]

{pluggy_sdk-1.0.0.post36.dist-info → pluggy_sdk-1.0.0.post37.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pluggy-sdk
-Version: 1.0.0.post36
+Version: 1.0.0.post37
 Summary: Pluggy API
 Home-page: https://github.com/diraol/pluggy-python
 Author: Pluggy
@@ -28,7 +28,7 @@ Pluggy's main API to review data and execute connectors
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.0.post36
+- Package version: 1.0.0.post37
 - Generator version: 7.12.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://pluggy.ai](https://pluggy.ai)
@@ -129,6 +129,9 @@ Class | Method | HTTP request | Description
 *BenefitApi* | [**benefits_list**](docs/BenefitApi.md#benefits_list) | **GET** /benefits | List
 *BillApi* | [**bills_list**](docs/BillApi.md#bills_list) | **GET** /bills | List
 *BillApi* | [**bills_retrieve**](docs/BillApi.md#bills_retrieve) | **GET** /bills/{id} | Retrieve
+*BoletoManagementApi* | [**boleto_cancel**](docs/BoletoManagementApi.md#boleto_cancel) | **POST** /boletos/{id}/cancel | Cancel Boleto
+*BoletoManagementApi* | [**boleto_connection_create**](docs/BoletoManagementApi.md#boleto_connection_create) | **POST** /boleto-connections | Connect boleto credentials
+*BoletoManagementApi* | [**boleto_create**](docs/BoletoManagementApi.md#boleto_create) | **POST** /boletos | Issue Boleto
 *BulkPaymentApi* | [**bulk_payment_create**](docs/BulkPaymentApi.md#bulk_payment_create) | **POST** /payments/bulk | Create
 *BulkPaymentApi* | [**bulk_payment_delete**](docs/BulkPaymentApi.md#bulk_payment_delete) | **DELETE** /payments/bulk/{id} | Delete
 *BulkPaymentApi* | [**bulk_payment_retrieve**](docs/BulkPaymentApi.md#bulk_payment_retrieve) | **GET** /payments/bulk/{id} | Retrieve
@@ -221,6 +224,7 @@ Class | Method | HTTP request | Description
  - [BillFinanceCharge](docs/BillFinanceCharge.md)
  - [BillsList200Response](docs/BillsList200Response.md)
  - [Boleto](docs/Boleto.md)
+ - [BoletoConnection](docs/BoletoConnection.md)
  - [BoletoPayer](docs/BoletoPayer.md)
  - [BoletoRecipient](docs/BoletoRecipient.md)
  - [BulkPayment](docs/BulkPayment.md)
@@ -238,6 +242,10 @@ Class | Method | HTTP request | Description
  - [ConnectorListResponse](docs/ConnectorListResponse.md)
  - [ConnectorUserAction](docs/ConnectorUserAction.md)
  - [Consent](docs/Consent.md)
+ - [CreateBoleto](docs/CreateBoleto.md)
+ - [CreateBoletoBoleto](docs/CreateBoletoBoleto.md)
+ - [CreateBoletoBoletoPayer](docs/CreateBoletoBoletoPayer.md)
+ - [CreateBoletoConnection](docs/CreateBoletoConnection.md)
  - [CreateBoletoPaymentRequest](docs/CreateBoletoPaymentRequest.md)
  - [CreateBulkPayment](docs/CreateBulkPayment.md)
  - [CreateClientCategoryRule](docs/CreateClientCategoryRule.md)
@@ -276,6 +284,8 @@ Class | Method | HTTP request | Description
  - [InvestmentMetadata](docs/InvestmentMetadata.md)
  - [InvestmentTransaction](docs/InvestmentTransaction.md)
  - [InvestmentsList200Response](docs/InvestmentsList200Response.md)
+ - [IssuedBoleto](docs/IssuedBoleto.md)
+ - [IssuedBoletoPayer](docs/IssuedBoletoPayer.md)
  - [Item](docs/Item.md)
  - [ItemCreationErrorResponse](docs/ItemCreationErrorResponse.md)
  - [ItemError](docs/ItemError.md)
@@ -310,6 +320,7 @@ Class | Method | HTTP request | Description
  - [PaymentDataParticipant](docs/PaymentDataParticipant.md)
  - [PaymentInstitution](docs/PaymentInstitution.md)
  - [PaymentIntent](docs/PaymentIntent.md)
+ - [PaymentIntentErrorDetail](docs/PaymentIntentErrorDetail.md)
  - [PaymentIntentParameter](docs/PaymentIntentParameter.md)
  - [PaymentIntentsList200Response](docs/PaymentIntentsList200Response.md)
  - [PaymentReceipt](docs/PaymentReceipt.md)
@@ -321,6 +332,7 @@ Class | Method | HTTP request | Description
  - [PaymentRecipientsList200Response](docs/PaymentRecipientsList200Response.md)
  - [PaymentRequest](docs/PaymentRequest.md)
  - [PaymentRequestCallbackUrls](docs/PaymentRequestCallbackUrls.md)
+ - [PaymentRequestErrorDetail](docs/PaymentRequestErrorDetail.md)
  - [PaymentRequestReceiptList200Response](docs/PaymentRequestReceiptList200Response.md)
  - [PaymentRequestSchedule](docs/PaymentRequestSchedule.md)
  - [PaymentRequestsList200Response](docs/PaymentRequestsList200Response.md)