pluggy-sdk 1.0.0.post11__py3-none-any.whl → 1.0.0.post13__py3-none-any.whl

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_schedule import PaymentRequestSchedule
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -42,13 +43,14 @@ class PaymentRequest(BaseModel):
     payment_url: StrictStr = Field(description="URL to begin the payment intent creation flow for this payment request", alias="paymentUrl")
     pix_qr_code: Optional[StrictStr] = Field(default=None, description="Pix QR code generated by the payment receiver", alias="pixQrCode")
     boleto: Optional[Boleto] = None
-    __properties: ClassVar[List[str]] = ["id", "amount", "description", "status", "clientPaymentId", "createdAt", "updatedAt", "callbackUrls", "recipientId", "paymentUrl", "pixQrCode", "boleto"]
+    schedule: Optional[PaymentRequestSchedule] = None
+    __properties: ClassVar[List[str]] = ["id", "amount", "description", "status", "clientPaymentId", "createdAt", "updatedAt", "callbackUrls", "recipientId", "paymentUrl", "pixQrCode", "boleto", "schedule"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['CREATED', 'IN_PROGRESS', 'COMPLETED', 'ERROR']):
-            raise ValueError("must be one of enum values ('CREATED', 'IN_PROGRESS', 'COMPLETED', 'ERROR')")
+        if value not in set(['CREATED', 'IN_PROGRESS', 'COMPLETED', 'SCHEDULED', 'WAITING_PAYER_AUTHORIZATION', 'ERROR', 'REFUND_IN_PROGRESS', 'REFUNDED', 'REFUND_ERROR']):
+            raise ValueError("must be one of enum values ('CREATED', 'IN_PROGRESS', 'COMPLETED', 'SCHEDULED', 'WAITING_PAYER_AUTHORIZATION', 'ERROR', 'REFUND_IN_PROGRESS', 'REFUNDED', 'REFUND_ERROR')")
         return value
 
     model_config = ConfigDict(
@@ -96,6 +98,9 @@ class PaymentRequest(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of boleto
         if self.boleto:
             _dict['boleto'] = self.boleto.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of schedule
+        if self.schedule:
+            _dict['schedule'] = self.schedule.to_dict()
         return _dict
 
     @classmethod
@@ -119,7 +124,8 @@ class PaymentRequest(BaseModel):
             "recipientId": obj.get("recipientId"),
             "paymentUrl": obj.get("paymentUrl"),
             "pixQrCode": obj.get("pixQrCode"),
-            "boleto": Boleto.from_dict(obj["boleto"]) if obj.get("boleto") is not None else None
+            "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
         })
         return _obj
 

pluggy_sdk/models/payment_request_schedule.py

@@ -0,0 +1,183 @@
+# 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, List, Optional
+from pluggy_sdk.models.schedule_type_custom import ScheduleTypeCustom
+from pluggy_sdk.models.schedule_type_daily import ScheduleTypeDaily
+from pluggy_sdk.models.schedule_type_monthly import ScheduleTypeMonthly
+from pluggy_sdk.models.schedule_type_single import ScheduleTypeSingle
+from pluggy_sdk.models.schedule_type_weekly import ScheduleTypeWeekly
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+PAYMENTREQUESTSCHEDULE_ONE_OF_SCHEMAS = ["ScheduleTypeCustom", "ScheduleTypeDaily", "ScheduleTypeMonthly", "ScheduleTypeSingle", "ScheduleTypeWeekly"]
+
+class PaymentRequestSchedule(BaseModel):
+    """
+    PaymentRequestSchedule
+    """
+    # data type: ScheduleTypeSingle
+    oneof_schema_1_validator: Optional[ScheduleTypeSingle] = None
+    # data type: ScheduleTypeDaily
+    oneof_schema_2_validator: Optional[ScheduleTypeDaily] = None
+    # data type: ScheduleTypeWeekly
+    oneof_schema_3_validator: Optional[ScheduleTypeWeekly] = None
+    # data type: ScheduleTypeMonthly
+    oneof_schema_4_validator: Optional[ScheduleTypeMonthly] = None
+    # data type: ScheduleTypeCustom
+    oneof_schema_5_validator: Optional[ScheduleTypeCustom] = None
+    actual_instance: Optional[Union[ScheduleTypeCustom, ScheduleTypeDaily, ScheduleTypeMonthly, ScheduleTypeSingle, ScheduleTypeWeekly]] = None
+    one_of_schemas: Set[str] = { "ScheduleTypeCustom", "ScheduleTypeDaily", "ScheduleTypeMonthly", "ScheduleTypeSingle", "ScheduleTypeWeekly" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    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 = PaymentRequestSchedule.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: ScheduleTypeSingle
+        if not isinstance(v, ScheduleTypeSingle):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScheduleTypeSingle`")
+        else:
+            match += 1
+        # validate data type: ScheduleTypeDaily
+        if not isinstance(v, ScheduleTypeDaily):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScheduleTypeDaily`")
+        else:
+            match += 1
+        # validate data type: ScheduleTypeWeekly
+        if not isinstance(v, ScheduleTypeWeekly):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScheduleTypeWeekly`")
+        else:
+            match += 1
+        # validate data type: ScheduleTypeMonthly
+        if not isinstance(v, ScheduleTypeMonthly):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScheduleTypeMonthly`")
+        else:
+            match += 1
+        # validate data type: ScheduleTypeCustom
+        if not isinstance(v, ScheduleTypeCustom):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScheduleTypeCustom`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in PaymentRequestSchedule with oneOf schemas: ScheduleTypeCustom, ScheduleTypeDaily, ScheduleTypeMonthly, ScheduleTypeSingle, ScheduleTypeWeekly. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in PaymentRequestSchedule with oneOf schemas: ScheduleTypeCustom, ScheduleTypeDaily, ScheduleTypeMonthly, ScheduleTypeSingle, ScheduleTypeWeekly. 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 ScheduleTypeSingle
+        try:
+            instance.actual_instance = ScheduleTypeSingle.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScheduleTypeDaily
+        try:
+            instance.actual_instance = ScheduleTypeDaily.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScheduleTypeWeekly
+        try:
+            instance.actual_instance = ScheduleTypeWeekly.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScheduleTypeMonthly
+        try:
+            instance.actual_instance = ScheduleTypeMonthly.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScheduleTypeCustom
+        try:
+            instance.actual_instance = ScheduleTypeCustom.from_json(json_str)
+            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 PaymentRequestSchedule with oneOf schemas: ScheduleTypeCustom, ScheduleTypeDaily, ScheduleTypeMonthly, ScheduleTypeSingle, ScheduleTypeWeekly. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into PaymentRequestSchedule with oneOf schemas: ScheduleTypeCustom, ScheduleTypeDaily, ScheduleTypeMonthly, ScheduleTypeSingle, ScheduleTypeWeekly. 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], ScheduleTypeCustom, ScheduleTypeDaily, ScheduleTypeMonthly, ScheduleTypeSingle, ScheduleTypeWeekly]]:
+        """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/payment_schedules_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.schedule_payment import SchedulePayment
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PaymentSchedulesList200Response(BaseModel):
+    """
+    PaymentSchedulesList200Response
+    """ # 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[SchedulePayment]] = Field(default=None, description="List of scheduled payments from a payment request")
+    __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 PaymentSchedulesList200Response 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 in self.results:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['results'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaymentSchedulesList200Response 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": [SchedulePayment.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/payroll_loan.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.payroll_loan_client import PayrollLoanClient
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PayrollLoan(BaseModel):
+    """
+    Information related to a payroll loan
+    """ # noqa: E501
+    contract_code: StrictStr = Field(description="Contract code given by the contracting institution", alias="contractCode")
+    cnpj_original_contract_creditor: Optional[StrictStr] = Field(default=None, description="CNPJ of the original creditor of the contract", alias="cnpjOriginalContractCreditor")
+    nominal_interest_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Nominal interest rate", alias="nominalInterestRate")
+    efective_interest_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Effective interest rate", alias="efectiveInterestRate")
+    cet_annual_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="CET annual rate", alias="cetAnnualRate")
+    cet_month_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="CET monthly rate", alias="cetMonthRate")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Code referencing the currency of the loan", alias="currencyCode")
+    amortization_regime: Optional[StrictStr] = Field(default=None, description="Amortization regime", alias="amortizationRegime")
+    installments_quantity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Number of installments", alias="installmentsQuantity")
+    installments_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Installment value", alias="installmentsValue")
+    due_date_first_installment: Optional[datetime] = Field(default=None, description="Due date of the first installment", alias="dueDateFirstInstallment")
+    due_date_last_installment: Optional[datetime] = Field(default=None, description="Due date of the last installment", alias="dueDateLastInstallment")
+    cnpj_correspondent_banking: Optional[StrictStr] = Field(default=None, description="CNPJ of the correspondent banking", alias="cnpjCorrespondentBanking")
+    operation_hiring_date: Optional[datetime] = Field(default=None, description="Operation hiring date", alias="operationHiringDate")
+    client: PayrollLoanClient
+    __properties: ClassVar[List[str]] = ["contractCode", "cnpjOriginalContractCreditor", "nominalInterestRate", "efectiveInterestRate", "cetAnnualRate", "cetMonthRate", "currencyCode", "amortizationRegime", "installmentsQuantity", "installmentsValue", "dueDateFirstInstallment", "dueDateLastInstallment", "cnpjCorrespondentBanking", "operationHiringDate", "client"]
+
+    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 PayrollLoan 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 client
+        if self.client:
+            _dict['client'] = self.client.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PayrollLoan from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "contractCode": obj.get("contractCode"),
+            "cnpjOriginalContractCreditor": obj.get("cnpjOriginalContractCreditor"),
+            "nominalInterestRate": obj.get("nominalInterestRate"),
+            "efectiveInterestRate": obj.get("efectiveInterestRate"),
+            "cetAnnualRate": obj.get("cetAnnualRate"),
+            "cetMonthRate": obj.get("cetMonthRate"),
+            "currencyCode": obj.get("currencyCode"),
+            "amortizationRegime": obj.get("amortizationRegime"),
+            "installmentsQuantity": obj.get("installmentsQuantity"),
+            "installmentsValue": obj.get("installmentsValue"),
+            "dueDateFirstInstallment": obj.get("dueDateFirstInstallment"),
+            "dueDateLastInstallment": obj.get("dueDateLastInstallment"),
+            "cnpjCorrespondentBanking": obj.get("cnpjCorrespondentBanking"),
+            "operationHiringDate": obj.get("operationHiringDate"),
+            "client": PayrollLoanClient.from_dict(obj["client"]) if obj.get("client") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/payroll_loan_client.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PayrollLoanClient(BaseModel):
+    """
+    Client information
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="Client name")
+    document: Optional[StrictStr] = Field(default=None, description="Client CPF")
+    phone: Optional[StrictStr] = Field(default=None, description="Client phone")
+    addres_street: Optional[StrictStr] = Field(default=None, description="Client email", alias="addresStreet")
+    address_number: Optional[StrictStr] = Field(default=None, description="Client address number", alias="addressNumber")
+    address_city: Optional[StrictStr] = Field(default=None, description="Client address city", alias="addressCity")
+    address_zip_code: Optional[StrictStr] = Field(default=None, description="Client address zip code", alias="addressZipCode")
+    address_state: Optional[StrictStr] = Field(default=None, description="Client address state", alias="addressState")
+    __properties: ClassVar[List[str]] = ["name", "document", "phone", "addresStreet", "addressNumber", "addressCity", "addressZipCode", "addressState"]
+
+    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 PayrollLoanClient 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 PayrollLoanClient from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "document": obj.get("document"),
+            "phone": obj.get("phone"),
+            "addresStreet": obj.get("addresStreet"),
+            "addressNumber": obj.get("addressNumber"),
+            "addressCity": obj.get("addressCity"),
+            "addressZipCode": obj.get("addressZipCode"),
+            "addressState": obj.get("addressState")
+        })
+        return _obj
+
+