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

unit_finance_sdk/models/business_customer_relationships.py

@@ -0,0 +1,125 @@
+# 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
+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 BusinessCustomerRelationships(BaseModel):
+    """
+    BusinessCustomerRelationships
+    """ # noqa: E501
+    org: Optional[Relationship] = None
+    application: Optional[Relationship] = None
+    authorized_user_resources: Optional[Relationship] = Field(default=None, alias="authorizedUserResources")
+    officer: Optional[Relationship] = None
+    beneficial_owners: Optional[Relationship] = Field(default=None, alias="beneficialOwners")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["org", "application", "authorizedUserResources", "officer", "beneficialOwners"]
+
+    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 BusinessCustomerRelationships 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 org
+        if self.org:
+            _dict['org'] = self.org.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of application
+        if self.application:
+            _dict['application'] = self.application.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of authorized_user_resources
+        if self.authorized_user_resources:
+            _dict['authorizedUserResources'] = self.authorized_user_resources.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of officer
+        if self.officer:
+            _dict['officer'] = self.officer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of beneficial_owners
+        if self.beneficial_owners:
+            _dict['beneficialOwners'] = self.beneficial_owners.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 BusinessCustomerRelationships from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "org": Relationship.from_dict(obj["org"]) if obj.get("org") is not None else None,
+            "application": Relationship.from_dict(obj["application"]) if obj.get("application") is not None else None,
+            "authorizedUserResources": Relationship.from_dict(obj["authorizedUserResources"]) if obj.get("authorizedUserResources") is not None else None,
+            "officer": Relationship.from_dict(obj["officer"]) if obj.get("officer") is not None else None,
+            "beneficialOwners": Relationship.from_dict(obj["beneficialOwners"]) if obj.get("beneficialOwners") 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/business_debit_card.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.business_debit_card_attributes import BusinessDebitCardAttributes
+from unit_finance_sdk.models.cash_deposit_barcode_relationships import CashDepositBarcodeRelationships
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class BusinessDebitCard(BaseModel):
+    """
+    `BusinessDebitCard` is a JSON:API resource, top-level fields:
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: BusinessDebitCardAttributes
+    relationships: Optional[CashDepositBarcodeRelationships] = 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(['businessDebitCard']):
+            raise ValueError("must be one of enum values ('businessDebitCard')")
+        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 BusinessDebitCard 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 BusinessDebitCard 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": BusinessDebitCardAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": CashDepositBarcodeRelationships.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/business_debit_card_attributes.py

@@ -0,0 +1,148 @@
+# 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, datetime
+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.full_name_type import FullNameType
+from unit_finance_sdk.models.phone_type import PhoneType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class BusinessDebitCardAttributes(BaseModel):
+    """
+    BusinessDebitCardAttributes
+    """ # 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")
+    last4_digits: StrictStr = Field(description="Last 4 digits of the debit card.", alias="last4Digits")
+    expiration_date: StrictStr = Field(description="Card expiration date, formatted YYYY-MM, e.g \"2020-05\".", alias="expirationDate")
+    shipping_address: Optional[AddressType] = Field(default=None, description="Shipping address, if specified.", alias="shippingAddress")
+    ssn: Optional[StrictStr] = Field(default=None, description="SSN of the card holder (numbers only), if specified during card creation.")
+    passport: Optional[StrictStr] = Field(default=None, description="Passport number of the card holder, if specified during card creation.")
+    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 card holder nationality. (e.g. \"US\").")
+    full_name: FullNameType = Field(description="Full name of the card holder.", alias="fullName")
+    date_of_birth: date = Field(description="Date of birth of the card holder (e.g. \"2001-08-15\").", alias="dateOfBirth")
+    address: AddressType = Field(description="Address of the card holder.")
+    bin: StrictStr = Field(description="9-digit Bank Identification Number (BIN).")
+    phone: PhoneType = Field(description="Phone of the card holder.")
+    email: StrictStr = Field(description="Email address of the card holder.")
+    status: StrictStr = Field(description="Status of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.")
+    design: Optional[StrictStr] = Field(default=None, description="Card design, if specified.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["createdAt", "updatedAt", "last4Digits", "expirationDate", "shippingAddress", "ssn", "passport", "nationality", "fullName", "dateOfBirth", "address", "bin", "phone", "email", "status", "design"]
+
+    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 BusinessDebitCardAttributes 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 shipping_address
+        if self.shipping_address:
+            _dict['shippingAddress'] = self.shipping_address.to_dict()
+        # 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 BusinessDebitCardAttributes 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"),
+            "last4Digits": obj.get("last4Digits"),
+            "expirationDate": obj.get("expirationDate"),
+            "shippingAddress": AddressType.from_dict(obj["shippingAddress"]) if obj.get("shippingAddress") is not None else None,
+            "ssn": obj.get("ssn"),
+            "passport": obj.get("passport"),
+            "nationality": obj.get("nationality"),
+            "fullName": FullNameType.from_dict(obj["fullName"]) if obj.get("fullName") is not None else None,
+            "dateOfBirth": obj.get("dateOfBirth"),
+            "address": AddressType.from_dict(obj["address"]) if obj.get("address") is not None else None,
+            "bin": obj.get("bin"),
+            "phone": PhoneType.from_dict(obj["phone"]) if obj.get("phone") is not None else None,
+            "email": obj.get("email"),
+            "status": obj.get("status"),
+            "design": obj.get("design")
+        })
+        # 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/business_number_of_employees_type.py

@@ -0,0 +1,40 @@
+# 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 BusinessNumberOfEmployeesType(str, Enum):
+    """
+    The number of employees of a business.
+    """
+
+    """
+    allowed enum values
+    """
+    UPTO10 = 'UpTo10'
+    BETWEEN10AND50 = 'Between10And50'
+    BETWEEN50AND100 = 'Between50And100'
+    BETWEEN100AND500 = 'Between100And500'
+    OVER500 = 'Over500'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BusinessNumberOfEmployeesType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unit_finance_sdk/models/business_vertical_type.py

@@ -0,0 +1,66 @@
+# 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 BusinessVerticalType(str, Enum):
+    """
+    The business vertical/industry of a sole proprietor or a business.
+    """
+
+    """
+    allowed enum values
+    """
+    ADULTENTERTAINMENTDATINGORESCORTSERVICES = 'AdultEntertainmentDatingOrEscortServices'
+    ADVERTISINGORMARKETING = 'AdvertisingOrMarketing'
+    AGRICULTUREFORESTRYFISHINGORHUNTING = 'AgricultureForestryFishingOrHunting'
+    ARTSENTERTAINMENTANDRECREATION = 'ArtsEntertainmentAndRecreation'
+    BUSINESSSUPPORTORBUILDINGSERVICES = 'BusinessSupportOrBuildingServices'
+    CANNABIS = 'Cannabis'
+    CONSTRUCTION = 'Construction'
+    DIRECTMARKETINGORTELEMARKETING = 'DirectMarketingOrTelemarketing'
+    EDUCATIONALSERVICES = 'EducationalServices'
+    FINANCIALSERVICESCRYPTOCURRENCY = 'FinancialServicesCryptocurrency'
+    FINANCIALSERVICESDEBITCOLLECTIONORCONSOLIDATION = 'FinancialServicesDebitCollectionOrConsolidation'
+    FINANCIALSERVICESMONEYSERVICESBUSINESSORCURRENCYEXCHANGE = 'FinancialServicesMoneyServicesBusinessOrCurrencyExchange'
+    FINANCIALSERVICESOTHER = 'FinancialServicesOther'
+    FINANCIALSERVICESPAYDAYLENDING = 'FinancialServicesPaydayLending'
+    GAMINGORGAMBLING = 'GamingOrGambling'
+    HEALTHCAREANDSOCIALASSISTANCE = 'HealthCareAndSocialAssistance'
+    HOSPITALITYACCOMMODATIONORFOODSERVICES = 'HospitalityAccommodationOrFoodServices'
+    LEGALACCOUNTINGCONSULTINGORCOMPUTERPROGRAMMING = 'LegalAccountingConsultingOrComputerProgramming'
+    MANUFACTURING = 'Manufacturing'
+    MINING = 'Mining'
+    NUTRACEUTICALS = 'Nutraceuticals'
+    PERSONALCARESERVICES = 'PersonalCareServices'
+    PUBLICADMINISTRATION = 'PublicAdministration'
+    REALESTATE = 'RealEstate'
+    RELIGIOUSCIVICANDSOCIALORGANIZATIONS = 'ReligiousCivicAndSocialOrganizations'
+    REPAIRANDMAINTENANCE = 'RepairAndMaintenance'
+    RETAILTRADE = 'RetailTrade'
+    TECHNOLOGYMEDIAORTELECOM = 'TechnologyMediaOrTelecom'
+    TRANSPORTATIONORWAREHOUSING = 'TransportationOrWarehousing'
+    UTILITIES = 'Utilities'
+    WHOLESALETRADE = 'WholesaleTrade'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BusinessVerticalType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unit_finance_sdk/models/business_virtual_credit_card.py

@@ -0,0 +1,118 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.cash_deposit_barcode_relationships import CashDepositBarcodeRelationships
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class BusinessVirtualCreditCard(BaseModel):
+    """
+    `BusinessVirtualCreditCard` is a JSON:API resource returned by the Create Business Virtual Credit Card operation.
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: Dict[str, Any] = Field(description="Attributes of the business virtual credit card.")
+    relationships: Optional[CashDepositBarcodeRelationships] = 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(['businessVirtualCreditCard']):
+            raise ValueError("must be one of enum values ('businessVirtualCreditCard')")
+        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 BusinessVirtualCreditCard 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 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 BusinessVirtualCreditCard 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": obj.get("attributes"),
+            "relationships": CashDepositBarcodeRelationships.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
+
+