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

unit_finance_sdk/models/create_individual_application_data_attributes.py

@@ -0,0 +1,158 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.address_type import AddressType
+from unit_finance_sdk.models.annual_income_type import AnnualIncomeType
+from unit_finance_sdk.models.device_fingerprint_type import DeviceFingerprintType
+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 CreateIndividualApplicationDataAttributes(BaseModel):
+    """
+    CreateIndividualApplicationDataAttributes
+    """ # noqa: E501
+    ssn: Optional[StrictStr] = Field(default=None, description="SSN (or ITIN) of the individual (numbers only). Either an ssn or passport is required. It is optional to provide only last 4 SSN digits.")
+    passport: Optional[StrictStr] = Field(default=None, description="Passport number of the individual. Valid only for non-US persons. Either an ssn or passport number is required.")
+    nationality: Optional[StrictStr] = Field(default=None, description="Required if a passport is used as the main ID. Two letters representing the individual nationality. (e.g. \"US\").")
+    full_name: FullNameType = Field(description="Full name of the individual.", alias="fullName")
+    date_of_birth: StrictStr = Field(description="Date only (e.g. \"2001-08-15\").", alias="dateOfBirth")
+    address: AddressType = Field(description="Address of the individual. Must be a US address.")
+    phone: PhoneType = Field(description="Phone number of the individual.")
+    email: StrictStr = Field(description="Email address of the individual.")
+    evaluation_params: Optional[StrictStr] = Field(default=None, description="Optional. Evaluation Params for this entity.", alias="evaluationParams")
+    occupation: OccupationType = Field(description="Occupation of the individual.")
+    annual_income: AnnualIncomeType = Field(description="Required if nationality is not US. Annual income of the individual.", alias="annualIncome")
+    source_of_income: SourceOfIncomeType = Field(description="Required if nationality is not US. Source of income of the individual.", alias="sourceOfIncome")
+    ip: Optional[StrictStr] = Field(default=None, description="Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.")
+    tags: Optional[Dict[str, Any]] = Field(default=None, description="Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).")
+    idempotency_key: Optional[StrictStr] = Field(default=None, description="Optional. See Idempotency.", alias="idempotencyKey")
+    device_fingerprints: Optional[List[DeviceFingerprintType]] = Field(default=None, description="Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).", alias="deviceFingerprints")
+    jwt_subject: Optional[StrictStr] = Field(default=None, description="Optional. See this section for more information.", alias="jwtSubject")
+    banks: Optional[List[StrictStr]] = Field(default=None, description="Optional. The name of the bank or banks that should be associated with this application. If not specified, the application will be associated with the Org's default bank (visible via Org Settings in the Dashboard).")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["ssn", "passport", "nationality", "fullName", "dateOfBirth", "address", "phone", "email", "evaluationParams", "occupation", "annualIncome", "sourceOfIncome", "ip", "tags", "idempotencyKey", "deviceFingerprints", "jwtSubject", "banks"]
+
+    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 CreateIndividualApplicationDataAttributes 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()
+        # override the default output from pydantic by calling `to_dict()` of each item in device_fingerprints (list)
+        _items = []
+        if self.device_fingerprints:
+            for _item_device_fingerprints in self.device_fingerprints:
+                if _item_device_fingerprints:
+                    _items.append(_item_device_fingerprints.to_dict())
+            _dict['deviceFingerprints'] = _items
+        # 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 CreateIndividualApplicationDataAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "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,
+            "phone": PhoneType.from_dict(obj["phone"]) if obj.get("phone") is not None else None,
+            "email": obj.get("email"),
+            "evaluationParams": obj.get("evaluationParams"),
+            "occupation": obj.get("occupation"),
+            "annualIncome": obj.get("annualIncome"),
+            "sourceOfIncome": obj.get("sourceOfIncome"),
+            "ip": obj.get("ip"),
+            "tags": obj.get("tags"),
+            "idempotencyKey": obj.get("idempotencyKey"),
+            "deviceFingerprints": [DeviceFingerprintType.from_dict(_item) for _item in obj["deviceFingerprints"]] if obj.get("deviceFingerprints") is not None else None,
+            "jwtSubject": obj.get("jwtSubject"),
+            "banks": obj.get("banks")
+        })
+        # 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_individual_application_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_individual_application_data import CreateIndividualApplicationData
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateIndividualApplicationRequest(BaseModel):
+    """
+    CreateIndividualApplicationRequest
+    """ # noqa: E501
+    data: CreateIndividualApplicationData
+    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 CreateIndividualApplicationRequest 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 CreateIndividualApplicationRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": CreateIndividualApplicationData.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_individual_debit_card_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_fee_data_relationships import CreateFeeDataRelationships
+from unit_finance_sdk.models.create_individual_debit_card_data_attributes import CreateIndividualDebitCardDataAttributes
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateIndividualDebitCardData(BaseModel):
+    """
+    CreateIndividualDebitCardData
+    """ # noqa: E501
+    type: StrictStr
+    attributes: CreateIndividualDebitCardDataAttributes
+    relationships: CreateFeeDataRelationships
+    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(['individualDebitCard']):
+            raise ValueError("must be one of enum values ('individualDebitCard')")
+        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 CreateIndividualDebitCardData 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 CreateIndividualDebitCardData 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": CreateIndividualDebitCardDataAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": CreateFeeDataRelationships.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_individual_debit_card_data_attributes.py

@@ -0,0 +1,119 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.address_type import AddressType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateIndividualDebitCardDataAttributes(BaseModel):
+    """
+    CreateIndividualDebitCardDataAttributes
+    """ # noqa: E501
+    shipping_address: Optional[AddressType] = Field(default=None, description="Address to ship the card to. If not specified, the individual address is used.", alias="shippingAddress")
+    design: Optional[StrictStr] = Field(default=None, description="You may omit if you only have one card design. Please contact Unit if you need multiple card designs.")
+    additional_embossed_text: Optional[StrictStr] = Field(default=None, description="Optional, up to 21 characters. Use for a second cardholder name, company name, or other data to be embossed on a card.", alias="additionalEmbossedText")
+    idempotency_key: Optional[StrictStr] = Field(default=None, description="See Idempotency.", alias="idempotencyKey")
+    tags: Optional[Dict[str, Any]] = Field(default=None, description="See Tags.")
+    limits: Optional[Dict[str, Any]] = Field(default=None, description="See Limits (cents).")
+    print_only_business_name: Optional[StrictBool] = Field(default=None, description="Optional, default is false. Print the business name on the card instead of the card holder's name. Available only for Sole Proprietorship typed customers that have a DBA property.", alias="printOnlyBusinessName")
+    expiry_date: Optional[StrictStr] = Field(default=None, description="Expiration date of the card in one of the formats MM/yy or yyyy-MM or yy-MM (e.g. \"03/27\"). Must be between 3 to 5 years. Default is 4 years.", alias="expiryDate")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["shippingAddress", "design", "additionalEmbossedText", "idempotencyKey", "tags", "limits", "printOnlyBusinessName", "expiryDate"]
+
+    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 CreateIndividualDebitCardDataAttributes 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()
+        # 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 CreateIndividualDebitCardDataAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "shippingAddress": AddressType.from_dict(obj["shippingAddress"]) if obj.get("shippingAddress") is not None else None,
+            "design": obj.get("design"),
+            "additionalEmbossedText": obj.get("additionalEmbossedText"),
+            "idempotencyKey": obj.get("idempotencyKey"),
+            "tags": obj.get("tags"),
+            "limits": obj.get("limits"),
+            "printOnlyBusinessName": obj.get("printOnlyBusinessName"),
+            "expiryDate": obj.get("expiryDate")
+        })
+        # 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_individual_debit_card_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_individual_debit_card_data import CreateIndividualDebitCardData
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateIndividualDebitCardRequest(BaseModel):
+    """
+    CreateIndividualDebitCardRequest
+    """ # noqa: E501
+    data: CreateIndividualDebitCardData
+    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 CreateIndividualDebitCardRequest 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 CreateIndividualDebitCardRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": CreateIndividualDebitCardData.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
+
+