unit-openapi-python-sdk 0.18.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

unit_finance_sdk/models/recurring_ach_repayment_attributes.py

@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.schedule_type import ScheduleType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class RecurringACHRepaymentAttributes(BaseModel):
+    """
+    RecurringACHRepaymentAttributes
+    """ # noqa: E501
+    created_at: datetime = Field(description="The date the resource was created.", alias="createdAt")
+    updated_at: Optional[datetime] = Field(default=None, description="The date the resource was updated.", alias="updatedAt")
+    schedule: ScheduleType = Field(description="The schedule of the recurring payment.")
+    description: StrictStr = Field(description="Repayment description (maximum of 50 characters). 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.")
+    same_day: Optional[StrictBool] = Field(default=None, description="Optional, default is false. See Same Day ACH.", alias="sameDay")
+    sec_code: Optional[StrictStr] = Field(default=None, description="See Use a custom SEC Code.", alias="secCode")
+    tags: Optional[Dict[str, Any]] = Field(default=None, description="See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).")
+    number_of_repayments: StrictInt = Field(description="Represents the number of repayments that were created by this recurring payment.", alias="numberOfRepayments")
+    status: StrictStr = Field(description="Status of the recurring repayment, one of: Active, Disabled.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["createdAt", "updatedAt", "schedule", "description", "addenda", "sameDay", "secCode", "tags", "numberOfRepayments", "status"]
+
+    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 RecurringACHRepaymentAttributes 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 RecurringACHRepaymentAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "createdAt": obj.get("createdAt"),
+            "updatedAt": obj.get("updatedAt"),
+            "schedule": ScheduleType.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None,
+            "description": obj.get("description"),
+            "addenda": obj.get("addenda"),
+            "sameDay": obj.get("sameDay"),
+            "secCode": obj.get("secCode"),
+            "tags": obj.get("tags"),
+            "numberOfRepayments": obj.get("numberOfRepayments"),
+            "status": obj.get("status")
+        })
+        # 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/recurring_ach_repayment_relationships.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.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
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.relationship import Relationship
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class RecurringACHRepaymentRelationships(BaseModel):
+    """
+    RecurringACHRepaymentRelationships
+    """ # noqa: E501
+    account: Optional[Relationship] = None
+    credit_account: Optional[Relationship] = Field(default=None, alias="creditAccount")
+    counterparty: Optional[Relationship] = None
+    customer: Optional[Relationship] = None
+    org: Optional[Relationship] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["account", "creditAccount", "counterparty", "customer", "org"]
+
+    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 RecurringACHRepaymentRelationships 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 account
+        if self.account:
+            _dict['account'] = self.account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of credit_account
+        if self.credit_account:
+            _dict['creditAccount'] = self.credit_account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of counterparty
+        if self.counterparty:
+            _dict['counterparty'] = self.counterparty.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of customer
+        if self.customer:
+            _dict['customer'] = self.customer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of org
+        if self.org:
+            _dict['org'] = self.org.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 RecurringACHRepaymentRelationships from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "account": Relationship.from_dict(obj["account"]) if obj.get("account") is not None else None,
+            "creditAccount": Relationship.from_dict(obj["creditAccount"]) if obj.get("creditAccount") is not None else None,
+            "counterparty": Relationship.from_dict(obj["counterparty"]) if obj.get("counterparty") is not None else None,
+            "customer": Relationship.from_dict(obj["customer"]) if obj.get("customer") is not None else None,
+            "org": Relationship.from_dict(obj["org"]) if obj.get("org") 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/recurring_book_repayment.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.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, Optional
+from unit_finance_sdk.models.recurring_book_repayment_attributes import RecurringBookRepaymentAttributes
+from unit_finance_sdk.models.recurring_book_repayment_relationships import RecurringBookRepaymentRelationships
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class RecurringBookRepayment(BaseModel):
+    """
+    `recurringBookRepayment` is a JSON:API resource.
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: RecurringBookRepaymentAttributes
+    relationships: Optional[RecurringBookRepaymentRelationships] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["type", "id", "attributes", "relationships"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['recurringBookRepayment']):
+            raise ValueError("must be one of enum values ('recurringBookRepayment')")
+        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 RecurringBookRepayment 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 RecurringBookRepayment 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"),
+            "id": obj.get("id"),
+            "attributes": RecurringBookRepaymentAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": RecurringBookRepaymentRelationships.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/recurring_book_repayment_attributes.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.schedule_type import ScheduleType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class RecurringBookRepaymentAttributes(BaseModel):
+    """
+    RecurringBookRepaymentAttributes
+    """ # noqa: E501
+    created_at: datetime = Field(description="The date the resource was created.", alias="createdAt")
+    updated_at: Optional[datetime] = Field(default=None, description="The date the resource was updated.", alias="updatedAt")
+    schedule: ScheduleType = Field(description="The schedule of the recurring payment.")
+    description: StrictStr = Field(description="Repayment description (maximum of 80 characters). this will show up on the statement of the counterparty.")
+    transaction_summary_override: Optional[StrictStr] = Field(default=None, description="If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).", alias="transactionSummaryOverride")
+    tags: Optional[Dict[str, Any]] = Field(default=None, description="See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).")
+    number_of_repayments: StrictInt = Field(description="Represents the number of repayments that were created by this recurring payment.", alias="numberOfRepayments")
+    status: StrictStr = Field(description="Status of the recurring repayment, one of: Active, Disabled.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["createdAt", "updatedAt", "schedule", "description", "transactionSummaryOverride", "tags", "numberOfRepayments", "status"]
+
+    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 RecurringBookRepaymentAttributes 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 RecurringBookRepaymentAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "createdAt": obj.get("createdAt"),
+            "updatedAt": obj.get("updatedAt"),
+            "schedule": ScheduleType.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None,
+            "description": obj.get("description"),
+            "transactionSummaryOverride": obj.get("transactionSummaryOverride"),
+            "tags": obj.get("tags"),
+            "numberOfRepayments": obj.get("numberOfRepayments"),
+            "status": obj.get("status")
+        })
+        # 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/recurring_book_repayment_relationships.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.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
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.relationship import Relationship
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class RecurringBookRepaymentRelationships(BaseModel):
+    """
+    RecurringBookRepaymentRelationships
+    """ # noqa: E501
+    account: Optional[Relationship] = None
+    credit_account: Optional[Relationship] = Field(default=None, alias="creditAccount")
+    counterparty: Optional[Relationship] = None
+    counterparty_account: Optional[Relationship] = Field(default=None, alias="counterpartyAccount")
+    customer: Optional[Relationship] = None
+    org: Optional[Relationship] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["account", "creditAccount", "counterparty", "counterpartyAccount", "customer", "org"]
+
+    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 RecurringBookRepaymentRelationships 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 account
+        if self.account:
+            _dict['account'] = self.account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of credit_account
+        if self.credit_account:
+            _dict['creditAccount'] = self.credit_account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of counterparty
+        if self.counterparty:
+            _dict['counterparty'] = self.counterparty.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of counterparty_account
+        if self.counterparty_account:
+            _dict['counterpartyAccount'] = self.counterparty_account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of customer
+        if self.customer:
+            _dict['customer'] = self.customer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of org
+        if self.org:
+            _dict['org'] = self.org.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 RecurringBookRepaymentRelationships from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "account": Relationship.from_dict(obj["account"]) if obj.get("account") is not None else None,
+            "creditAccount": Relationship.from_dict(obj["creditAccount"]) if obj.get("creditAccount") is not None else None,
+            "counterparty": Relationship.from_dict(obj["counterparty"]) if obj.get("counterparty") is not None else None,
+            "counterpartyAccount": Relationship.from_dict(obj["counterpartyAccount"]) if obj.get("counterpartyAccount") is not None else None,
+            "customer": Relationship.from_dict(obj["customer"]) if obj.get("customer") is not None else None,
+            "org": Relationship.from_dict(obj["org"]) if obj.get("org") 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
+
+