unit-openapi-python-sdk 0.0.2__py3-none-any.whl → 0.10.0__py3-none-any.whl

unit_finance_sdk/models/create_payment_request.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    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 unit_finance_sdk.models.create_a_book_payment_request import CreateABookPaymentRequest
+from unit_finance_sdk.models.create_a_wire_payment_request import CreateAWirePaymentRequest
+from unit_finance_sdk.models.create_ach_payment_existing_counterparty_request import CreateACHPaymentExistingCounterpartyRequest
+from unit_finance_sdk.models.create_ach_payment_plaid_token_request import CreateACHPaymentPlaidTokenRequest
+from unit_finance_sdk.models.create_ach_payment_request import CreateACHPaymentRequest
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+CREATEPAYMENTREQUEST_ONE_OF_SCHEMAS = ["CreateABookPaymentRequest", "CreateACHPaymentExistingCounterpartyRequest", "CreateACHPaymentPlaidTokenRequest", "CreateACHPaymentRequest", "CreateAWirePaymentRequest"]
+
+class CreatePaymentRequest(BaseModel):
+    """
+    CreatePaymentRequest
+    """
+    # data type: CreateACHPaymentRequest
+    oneof_schema_1_validator: Optional[CreateACHPaymentRequest] = None
+    # data type: CreateACHPaymentExistingCounterpartyRequest
+    oneof_schema_2_validator: Optional[CreateACHPaymentExistingCounterpartyRequest] = None
+    # data type: CreateACHPaymentPlaidTokenRequest
+    oneof_schema_3_validator: Optional[CreateACHPaymentPlaidTokenRequest] = None
+    # data type: CreateABookPaymentRequest
+    oneof_schema_4_validator: Optional[CreateABookPaymentRequest] = None
+    # data type: CreateAWirePaymentRequest
+    oneof_schema_5_validator: Optional[CreateAWirePaymentRequest] = None
+    actual_instance: Optional[Union[CreateABookPaymentRequest, CreateACHPaymentExistingCounterpartyRequest, CreateACHPaymentPlaidTokenRequest, CreateACHPaymentRequest, CreateAWirePaymentRequest]] = None
+    one_of_schemas: Set[str] = { "CreateABookPaymentRequest", "CreateACHPaymentExistingCounterpartyRequest", "CreateACHPaymentPlaidTokenRequest", "CreateACHPaymentRequest", "CreateAWirePaymentRequest" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = CreatePaymentRequest.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: CreateACHPaymentRequest
+        if not isinstance(v, CreateACHPaymentRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CreateACHPaymentRequest`")
+        else:
+            match += 1
+        # validate data type: CreateACHPaymentExistingCounterpartyRequest
+        if not isinstance(v, CreateACHPaymentExistingCounterpartyRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CreateACHPaymentExistingCounterpartyRequest`")
+        else:
+            match += 1
+        # validate data type: CreateACHPaymentPlaidTokenRequest
+        if not isinstance(v, CreateACHPaymentPlaidTokenRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CreateACHPaymentPlaidTokenRequest`")
+        else:
+            match += 1
+        # validate data type: CreateABookPaymentRequest
+        if not isinstance(v, CreateABookPaymentRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CreateABookPaymentRequest`")
+        else:
+            match += 1
+        # validate data type: CreateAWirePaymentRequest
+        if not isinstance(v, CreateAWirePaymentRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CreateAWirePaymentRequest`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in CreatePaymentRequest with oneOf schemas: CreateABookPaymentRequest, CreateACHPaymentExistingCounterpartyRequest, CreateACHPaymentPlaidTokenRequest, CreateACHPaymentRequest, CreateAWirePaymentRequest. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in CreatePaymentRequest with oneOf schemas: CreateABookPaymentRequest, CreateACHPaymentExistingCounterpartyRequest, CreateACHPaymentPlaidTokenRequest, CreateACHPaymentRequest, CreateAWirePaymentRequest. 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 CreateACHPaymentRequest
+        try:
+            instance.actual_instance = CreateACHPaymentRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CreateACHPaymentExistingCounterpartyRequest
+        try:
+            instance.actual_instance = CreateACHPaymentExistingCounterpartyRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CreateACHPaymentPlaidTokenRequest
+        try:
+            instance.actual_instance = CreateACHPaymentPlaidTokenRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CreateABookPaymentRequest
+        try:
+            instance.actual_instance = CreateABookPaymentRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CreateAWirePaymentRequest
+        try:
+            instance.actual_instance = CreateAWirePaymentRequest.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 CreatePaymentRequest with oneOf schemas: CreateABookPaymentRequest, CreateACHPaymentExistingCounterpartyRequest, CreateACHPaymentPlaidTokenRequest, CreateACHPaymentRequest, CreateAWirePaymentRequest. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into CreatePaymentRequest with oneOf schemas: CreateABookPaymentRequest, CreateACHPaymentExistingCounterpartyRequest, CreateACHPaymentPlaidTokenRequest, CreateACHPaymentRequest, CreateAWirePaymentRequest. 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], CreateABookPaymentRequest, CreateACHPaymentExistingCounterpartyRequest, CreateACHPaymentPlaidTokenRequest, CreateACHPaymentRequest, CreateAWirePaymentRequest]]:
+        """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())
+
+

unit_finance_sdk/models/create_recurring_credit_ach_payment_data.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from unit_finance_sdk.models.create_ach_payment_existing_counterparty_data_relationships import CreateACHPaymentExistingCounterpartyDataRelationships
+from unit_finance_sdk.models.create_recurring_credit_ach_payment_data_attributes import CreateRecurringCreditACHPaymentDataAttributes
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateRecurringCreditACHPaymentData(BaseModel):
+    """
+    CreateRecurringCreditACHPaymentData
+    """ # noqa: E501
+    type: StrictStr
+    attributes: CreateRecurringCreditACHPaymentDataAttributes
+    relationships: CreateACHPaymentExistingCounterpartyDataRelationships
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["type", "attributes", "relationships"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['recurringCreditAchPayment']):
+            raise ValueError("must be one of enum values ('recurringCreditAchPayment')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditACHPaymentData 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of attributes
+        if self.attributes:
+            _dict['attributes'] = self.attributes.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of relationships
+        if self.relationships:
+            _dict['relationships'] = self.relationships.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditACHPaymentData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "attributes": CreateRecurringCreditACHPaymentDataAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": CreateACHPaymentExistingCounterpartyDataRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/create_recurring_credit_ach_payment_data_attributes.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.create_schedule_type import CreateScheduleType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateRecurringCreditACHPaymentDataAttributes(BaseModel):
+    """
+    CreateRecurringCreditACHPaymentDataAttributes
+    """ # noqa: E501
+    amount: StrictInt = Field(description="The amount (in cents).")
+    description: StrictStr = Field(description="Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on the statement of the counterparty.")
+    addenda: Optional[StrictStr] = Field(default=None, description="Optional, additional payment description (maximum of 80 characters), not all institutions present that.")
+    schedule: CreateScheduleType = Field(description="The schedule details of the recurring payment. All times must be in the future.")
+    same_day: Optional[StrictBool] = Field(default=None, description="Optional, default is false. See Same Day ACH.", alias="sameDay")
+    idempotency_key: Optional[StrictStr] = Field(default=None, description="Optional. See Idempotency.", alias="idempotencyKey")
+    tags: Optional[Dict[str, Any]] = Field(default=None, description="Optional. See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["amount", "description", "addenda", "schedule", "sameDay", "idempotencyKey", "tags"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditACHPaymentDataAttributes 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of schedule
+        if self.schedule:
+            _dict['schedule'] = self.schedule.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditACHPaymentDataAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "amount": obj.get("amount"),
+            "description": obj.get("description"),
+            "addenda": obj.get("addenda"),
+            "schedule": CreateScheduleType.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None,
+            "sameDay": obj.get("sameDay"),
+            "idempotencyKey": obj.get("idempotencyKey"),
+            "tags": obj.get("tags")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/create_recurring_credit_ach_payment_request.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    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
+from typing import Any, ClassVar, Dict, List
+from unit_finance_sdk.models.create_recurring_credit_ach_payment_data import CreateRecurringCreditACHPaymentData
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateRecurringCreditACHPaymentRequest(BaseModel):
+    """
+    CreateRecurringCreditACHPaymentRequest
+    """ # noqa: E501
+    data: CreateRecurringCreditACHPaymentData
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["data"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditACHPaymentRequest 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditACHPaymentRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": CreateRecurringCreditACHPaymentData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/create_recurring_credit_book_payment_data.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from unit_finance_sdk.models.create_a_book_payment_data_relationships import CreateABookPaymentDataRelationships
+from unit_finance_sdk.models.create_recurring_credit_book_payment_data_attributes import CreateRecurringCreditBookPaymentDataAttributes
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateRecurringCreditBookPaymentData(BaseModel):
+    """
+    CreateRecurringCreditBookPaymentData
+    """ # noqa: E501
+    type: StrictStr
+    attributes: CreateRecurringCreditBookPaymentDataAttributes
+    relationships: CreateABookPaymentDataRelationships
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["type", "attributes", "relationships"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['recurringCreditBookPayment']):
+            raise ValueError("must be one of enum values ('recurringCreditBookPayment')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditBookPaymentData 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of attributes
+        if self.attributes:
+            _dict['attributes'] = self.attributes.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of relationships
+        if self.relationships:
+            _dict['relationships'] = self.relationships.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateRecurringCreditBookPaymentData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "attributes": CreateRecurringCreditBookPaymentDataAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": CreateABookPaymentDataRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+