pluggy-sdk 1.0.0.post12__py3-none-any.whl → 1.0.0.post14__py3-none-any.whl

pluggy_sdk/models/__init__.py

@@ -36,6 +36,11 @@ from pluggy_sdk.models.asset_distribution import AssetDistribution
 from pluggy_sdk.models.auth_request import AuthRequest
 from pluggy_sdk.models.auth_response import AuthResponse
 from pluggy_sdk.models.bank_data import BankData
+from pluggy_sdk.models.benefit_loan import BenefitLoan
+from pluggy_sdk.models.benefit_loan_client import BenefitLoanClient
+from pluggy_sdk.models.benefit_response import BenefitResponse
+from pluggy_sdk.models.benefit_response_paying_institution import BenefitResponsePayingInstitution
+from pluggy_sdk.models.benefits_list200_response import BenefitsList200Response
 from pluggy_sdk.models.bill import Bill
 from pluggy_sdk.models.bill_finance_charge import BillFinanceCharge
 from pluggy_sdk.models.bills_list200_response import BillsList200Response
@@ -44,6 +49,7 @@ from pluggy_sdk.models.boleto_payer import BoletoPayer
 from pluggy_sdk.models.boleto_recipient import BoletoRecipient
 from pluggy_sdk.models.bulk_payment import BulkPayment
 from pluggy_sdk.models.bulk_payments_list200_response import BulkPaymentsList200Response
+from pluggy_sdk.models.custom import CUSTOM
 from pluggy_sdk.models.category import Category
 from pluggy_sdk.models.client_category_rule import ClientCategoryRule
 from pluggy_sdk.models.company import Company
@@ -73,6 +79,7 @@ from pluggy_sdk.models.create_webhook import CreateWebhook
 from pluggy_sdk.models.credential_select_option import CredentialSelectOption
 from pluggy_sdk.models.credit_card_metadata import CreditCardMetadata
 from pluggy_sdk.models.credit_data import CreditData
+from pluggy_sdk.models.daily import DAILY
 from pluggy_sdk.models.document import Document
 from pluggy_sdk.models.email import Email
 from pluggy_sdk.models.global_error_response import GlobalErrorResponse
@@ -104,6 +111,7 @@ from pluggy_sdk.models.loan_payment_release_over_parcel_fee import LoanPaymentRe
 from pluggy_sdk.models.loan_payments import LoanPayments
 from pluggy_sdk.models.loan_warranty import LoanWarranty
 from pluggy_sdk.models.loans_list200_response import LoansList200Response
+from pluggy_sdk.models.monthly import MONTHLY
 from pluggy_sdk.models.merchant import Merchant
 from pluggy_sdk.models.monthly_portfolio import MonthlyPortfolio
 from pluggy_sdk.models.monthly_portfolio_response import MonthlyPortfolioResponse
@@ -138,18 +146,11 @@ from pluggy_sdk.models.payment_request_receipt_list200_response import PaymentRe
 from pluggy_sdk.models.payment_request_schedule import PaymentRequestSchedule
 from pluggy_sdk.models.payment_requests_list200_response import PaymentRequestsList200Response
 from pluggy_sdk.models.payment_schedules_list200_response import PaymentSchedulesList200Response
-from pluggy_sdk.models.payroll_loan_response import PayrollLoanResponse
-from pluggy_sdk.models.payroll_loan_response_client import PayrollLoanResponseClient
-from pluggy_sdk.models.payroll_loans_list200_response import PayrollLoansList200Response
 from pluggy_sdk.models.percentage_over_index import PercentageOverIndex
 from pluggy_sdk.models.phone_number import PhoneNumber
 from pluggy_sdk.models.pix_data import PixData
+from pluggy_sdk.models.single import SINGLE
 from pluggy_sdk.models.schedule_payment import SchedulePayment
-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 pluggy_sdk.models.smart_account import SmartAccount
 from pluggy_sdk.models.smart_account_address import SmartAccountAddress
 from pluggy_sdk.models.smart_account_balance import SmartAccountBalance
@@ -164,6 +165,7 @@ from pluggy_sdk.models.update_item_parameters import UpdateItemParameters
 from pluggy_sdk.models.update_payment_recipient import UpdatePaymentRecipient
 from pluggy_sdk.models.update_payment_request import UpdatePaymentRequest
 from pluggy_sdk.models.update_transaction import UpdateTransaction
+from pluggy_sdk.models.weekly import WEEKLY
 from pluggy_sdk.models.webhook import Webhook
 from pluggy_sdk.models.webhook_creation_error_response import WebhookCreationErrorResponse
 from pluggy_sdk.models.webhooks_list200_response import WebhooksList200Response

pluggy_sdk/models/benefit_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.benefit_loan_client import BenefitLoanClient
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BenefitLoan(BaseModel):
+    """
+    Information related to a benefit 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: BenefitLoanClient
+    __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 BenefitLoan 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 BenefitLoan 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": BenefitLoanClient.from_dict(obj["client"]) if obj.get("client") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/benefit_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 BenefitLoanClient(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 BenefitLoanClient 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 BenefitLoanClient 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
+
+

pluggy_sdk/models/benefit_response.py

@@ -0,0 +1,118 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pluggy_sdk.models.benefit_loan import BenefitLoan
+from pluggy_sdk.models.benefit_response_paying_institution import BenefitResponsePayingInstitution
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BenefitResponse(BaseModel):
+    """
+    Response with information related to a benefit
+    """ # noqa: E501
+    id: StrictStr = Field(description="Primary identifier")
+    item_id: StrictStr = Field(description="Identifier of the item linked to the loan", alias="itemId")
+    beneficiary_name: StrictStr = Field(description="Beneficiary name", alias="beneficiaryName")
+    available_margin_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Available margin value", alias="availableMarginValue")
+    margin_base_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Base margin value", alias="marginBaseValue")
+    deductible_available_margin_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Deductible available margin value", alias="deductibleAvailableMarginValue")
+    used_margin_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Used margin value", alias="usedMarginValue")
+    reserved_margin_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Reserved margin value", alias="reservedMarginValue")
+    paying_institution: Optional[BenefitResponsePayingInstitution] = Field(default=None, alias="payingInstitution")
+    loans: Optional[List[BenefitLoan]] = Field(default=None, description="List of benefit loans")
+    __properties: ClassVar[List[str]] = ["id", "itemId", "beneficiaryName", "availableMarginValue", "marginBaseValue", "deductibleAvailableMarginValue", "usedMarginValue", "reservedMarginValue", "payingInstitution", "loans"]
+
+    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 BenefitResponse 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 paying_institution
+        if self.paying_institution:
+            _dict['payingInstitution'] = self.paying_institution.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in loans (list)
+        _items = []
+        if self.loans:
+            for _item in self.loans:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['loans'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BenefitResponse 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"),
+            "itemId": obj.get("itemId"),
+            "beneficiaryName": obj.get("beneficiaryName"),
+            "availableMarginValue": obj.get("availableMarginValue"),
+            "marginBaseValue": obj.get("marginBaseValue"),
+            "deductibleAvailableMarginValue": obj.get("deductibleAvailableMarginValue"),
+            "usedMarginValue": obj.get("usedMarginValue"),
+            "reservedMarginValue": obj.get("reservedMarginValue"),
+            "payingInstitution": BenefitResponsePayingInstitution.from_dict(obj["payingInstitution"]) if obj.get("payingInstitution") is not None else None,
+            "loans": [BenefitLoan.from_dict(_item) for _item in obj["loans"]] if obj.get("loans") is not None else None
+        })
+        return _obj
+
+

pluggy_sdk/models/benefit_response_paying_institution.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 BenefitResponsePayingInstitution(BaseModel):
+    """
+    Paying institution information
+    """ # noqa: E501
+    code: Optional[StrictStr] = Field(default=None, description="Paying institution code")
+    name: Optional[StrictStr] = Field(default=None, description="Paying institution name")
+    agency: Optional[StrictStr] = Field(default=None, description="Paying institution agency")
+    account: Optional[StrictStr] = Field(default=None, description="Paying institution account")
+    __properties: ClassVar[List[str]] = ["code", "name", "agency", "account"]
+
+    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 BenefitResponsePayingInstitution 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 BenefitResponsePayingInstitution 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"),
+            "name": obj.get("name"),
+            "agency": obj.get("agency"),
+            "account": obj.get("account")
+        })
+        return _obj
+
+

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

pluggy_sdk/models/connector.py

@@ -54,8 +54,8 @@ class Connector(BaseModel):
             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', 'MOVE_SECURITY']):
-                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', 'MOVE_SECURITY')")
+            if i not in set(['ACCOUNTS', 'CREDIT_CARDS', 'TRANSACTIONS', 'PAYMENT_DATA', 'INVESTMENTS', 'INVESTMENTS_TRANSACTIONS', 'IDENTITY', 'BROKERAGE_NOTE', 'OPPORTUNITIES', 'PORTFOLIO', 'INCOME_REPORTS', 'MOVE_SECURITY', 'LOANS', 'ACQUIRER_OPERATIONS']):
+                raise ValueError("each list item must be one of ('ACCOUNTS', 'CREDIT_CARDS', 'TRANSACTIONS', 'PAYMENT_DATA', 'INVESTMENTS', 'INVESTMENTS_TRANSACTIONS', 'IDENTITY', 'BROKERAGE_NOTE', 'OPPORTUNITIES', 'PORTFOLIO', 'INCOME_REPORTS', 'MOVE_SECURITY', 'LOANS', 'ACQUIRER_OPERATIONS')")
         return value
 
     model_config = ConfigDict(

pluggy_sdk/models/create_item.py

@@ -42,8 +42,8 @@ class CreateItem(BaseModel):
             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')")
+            if i not in set(['ACCOUNTS', 'CREDIT_CARDS', 'TRANSACTIONS', 'PAYMENT_DATA', 'INVESTMENTS', 'INVESTMENTS_TRANSACTIONS', 'IDENTITY', 'BROKERAGE_NOTE', 'OPPORTUNITIES', 'PORTFOLIO', 'INCOME_REPORTS', 'MOVE_SECURITY', 'LOANS', 'ACQUIRER_OPERATIONS']):
+                raise ValueError("each list item must be one of ('ACCOUNTS', 'CREDIT_CARDS', 'TRANSACTIONS', 'PAYMENT_DATA', 'INVESTMENTS', 'INVESTMENTS_TRANSACTIONS', 'IDENTITY', 'BROKERAGE_NOTE', 'OPPORTUNITIES', 'PORTFOLIO', 'INCOME_REPORTS', 'MOVE_SECURITY', 'LOANS', 'ACQUIRER_OPERATIONS')")
         return value
 
     model_config = ConfigDict(