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

unit_finance_sdk/models/meta_pagination.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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class MetaPagination(BaseModel):
+    """
+    MetaPagination
+    """ # noqa: E501
+    total: Optional[StrictInt] = None
+    limit: Optional[StrictInt] = None
+    offset: Optional[StrictInt] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["total", "limit", "offset"]
+
+    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 MetaPagination 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,
+        )
+        # 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 MetaPagination from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total": obj.get("total"),
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset")
+        })
+        # 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/negative_balance_coverage_transaction.py

@@ -0,0 +1,122 @@
+# 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, Optional
+from unit_finance_sdk.models.account_end_of_day_relationships import AccountEndOfDayRelationships
+from unit_finance_sdk.models.check_deposit_transaction_attributes import CheckDepositTransactionAttributes
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class NegativeBalanceCoverageTransaction(BaseModel):
+    """
+    `negativeBalanceCoverageTransaction` is a JSON:API resource, top-level fields:
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: CheckDepositTransactionAttributes
+    relationships: Optional[AccountEndOfDayRelationships] = 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(['negativeBalanceCoverageTransaction']):
+            raise ValueError("must be one of enum values ('negativeBalanceCoverageTransaction')")
+        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 NegativeBalanceCoverageTransaction 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 NegativeBalanceCoverageTransaction 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": CheckDepositTransactionAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": AccountEndOfDayRelationships.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/number_of_employees_type.py

@@ -0,0 +1,44 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class NumberOfEmployeesType(str, Enum):
+    """
+    The number of employees of a sole proprietor or a business. Union of the business and sole-proprietor value sets; use BusinessNumberOfEmployees or SoleProprietorNumberOfEmployees for the per-entity subset.
+    """
+
+    """
+    allowed enum values
+    """
+    UPTO10 = 'UpTo10'
+    BETWEEN10AND50 = 'Between10And50'
+    BETWEEN50AND100 = 'Between50And100'
+    BETWEEN100AND500 = 'Between100And500'
+    OVER500 = 'Over500'
+    ONE = 'One'
+    BETWEEN2AND5 = 'Between2And5'
+    BETWEEN5AND10 = 'Between5And10'
+    OVER10 = 'Over10'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of NumberOfEmployeesType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unit_finance_sdk/models/occupation_type.py

@@ -0,0 +1,58 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class OccupationType(str, Enum):
+    """
+    The occupation of an individual. One of: `ArchitectOrEngineer`, `BusinessAnalystAccountantOrFinancialAdvisor`, `CommunityAndSocialServicesWorker`, `ConstructionMechanicOrMaintenanceWorker`, `Doctor`, `Educator`, `EntertainmentSportsArtsOrMedia`, `ExecutiveOrManager`, `FarmerFishermanForester`, `FoodServiceWorker`, `GigWorker`, `HospitalityOfficeOrAdministrativeSupportWorker`, `HouseholdManager`, `JanitorHousekeeperLandscaper`, `Lawyer`, `ManufacturingOrProductionWorker`, `MilitaryOrPublicSafety`, `NurseHealthcareTechnicianOrHealthcareSupport`, `PersonalCareOrServiceWorker`, `PilotDriverOperator`, `SalesRepresentativeBrokerAgent`, `ScientistOrTechnologist`, `Student`
+    """
+
+    """
+    allowed enum values
+    """
+    ARCHITECTORENGINEER = 'ArchitectOrEngineer'
+    BUSINESSANALYSTACCOUNTANTORFINANCIALADVISOR = 'BusinessAnalystAccountantOrFinancialAdvisor'
+    COMMUNITYANDSOCIALSERVICESWORKER = 'CommunityAndSocialServicesWorker'
+    CONSTRUCTIONMECHANICORMAINTENANCEWORKER = 'ConstructionMechanicOrMaintenanceWorker'
+    DOCTOR = 'Doctor'
+    EDUCATOR = 'Educator'
+    ENTERTAINMENTSPORTSARTSORMEDIA = 'EntertainmentSportsArtsOrMedia'
+    EXECUTIVEORMANAGER = 'ExecutiveOrManager'
+    FARMERFISHERMANFORESTER = 'FarmerFishermanForester'
+    FOODSERVICEWORKER = 'FoodServiceWorker'
+    GIGWORKER = 'GigWorker'
+    HOSPITALITYOFFICEORADMINISTRATIVESUPPORTWORKER = 'HospitalityOfficeOrAdministrativeSupportWorker'
+    HOUSEHOLDMANAGER = 'HouseholdManager'
+    JANITORHOUSEKEEPERLANDSCAPER = 'JanitorHousekeeperLandscaper'
+    LAWYER = 'Lawyer'
+    MANUFACTURINGORPRODUCTIONWORKER = 'ManufacturingOrProductionWorker'
+    MILITARYORPUBLICSAFETY = 'MilitaryOrPublicSafety'
+    NURSEHEALTHCARETECHNICIANORHEALTHCARESUPPORT = 'NurseHealthcareTechnicianOrHealthcareSupport'
+    PERSONALCAREORSERVICEWORKER = 'PersonalCareOrServiceWorker'
+    PILOTDRIVEROPERATOR = 'PilotDriverOperator'
+    SALESREPRESENTATIVEBROKERAGENT = 'SalesRepresentativeBrokerAgent'
+    SCIENTISTORTECHNOLOGIST = 'ScientistOrTechnologist'
+    STUDENT = 'Student'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of OccupationType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unit_finance_sdk/models/officer.py

@@ -0,0 +1,122 @@
+# 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, Optional
+from unit_finance_sdk.models.officer_attributes import OfficerAttributes
+from unit_finance_sdk.models.officer_relationships import OfficerRelationships
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class Officer(BaseModel):
+    """
+    Officer
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: OfficerAttributes
+    relationships: Optional[OfficerRelationships] = 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(['officer']):
+            raise ValueError("must be one of enum values ('officer')")
+        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 Officer 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 Officer 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": OfficerAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": OfficerRelationships.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/officer_attributes.py

@@ -0,0 +1,142 @@
+# 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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from unit_finance_sdk.models.address_type import AddressType
+from unit_finance_sdk.models.annual_income_type import AnnualIncomeType
+from unit_finance_sdk.models.full_name_type import FullNameType
+from unit_finance_sdk.models.occupation_type import OccupationType
+from unit_finance_sdk.models.phone_type import PhoneType
+from unit_finance_sdk.models.source_of_income_type import SourceOfIncomeType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class OfficerAttributes(BaseModel):
+    """
+    OfficerAttributes
+    """ # noqa: E501
+    status: StrictStr = Field(description="One of Approved, Denied or PendingReview.")
+    full_name: FullNameType = Field(description="Full name of the officer.", alias="fullName")
+    title: StrictStr = Field(description="Title of the officer. One of CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member.")
+    ssn: Optional[StrictStr] = Field(default=None, description="SSN (or ITIN) of the officer (numbers only). Either an ssn or passport is required.")
+    passport: Optional[StrictStr] = Field(default=None, description="Passport number of the officer. Valid only for non-US persons. Either an ssn or passport number is required.")
+    nationality: Optional[Annotated[str, Field(min_length=2, strict=True, max_length=2)]] = Field(default=None, description="Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the officer's nationality. (e.g. \"US\").")
+    date_of_birth: date = Field(description="Date only (e.g. \"2001-08-15\").", alias="dateOfBirth")
+    address: AddressType = Field(description="The officer's address.")
+    phone: PhoneType = Field(description="The officer's phone number.")
+    email: StrictStr = Field(description="The officer's email address.")
+    occupation: Optional[OccupationType] = Field(default=None, description="Optional. Occupation of the officer.")
+    annual_income: Optional[AnnualIncomeType] = Field(default=None, description="Optional. Annual income of the officer.", alias="annualIncome")
+    source_of_income: Optional[SourceOfIncomeType] = Field(default=None, description="Optional. Source of income of the officer.", alias="sourceOfIncome")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["status", "fullName", "title", "ssn", "passport", "nationality", "dateOfBirth", "address", "phone", "email", "occupation", "annualIncome", "sourceOfIncome"]
+
+    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 OfficerAttributes 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 full_name
+        if self.full_name:
+            _dict['fullName'] = self.full_name.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of address
+        if self.address:
+            _dict['address'] = self.address.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of phone
+        if self.phone:
+            _dict['phone'] = self.phone.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 OfficerAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "fullName": FullNameType.from_dict(obj["fullName"]) if obj.get("fullName") is not None else None,
+            "title": obj.get("title"),
+            "ssn": obj.get("ssn"),
+            "passport": obj.get("passport"),
+            "nationality": obj.get("nationality"),
+            "dateOfBirth": obj.get("dateOfBirth"),
+            "address": AddressType.from_dict(obj["address"]) if obj.get("address") is not None else None,
+            "phone": PhoneType.from_dict(obj["phone"]) if obj.get("phone") is not None else None,
+            "email": obj.get("email"),
+            "occupation": obj.get("occupation"),
+            "annualIncome": obj.get("annualIncome"),
+            "sourceOfIncome": obj.get("sourceOfIncome")
+        })
+        # 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
+
+