vortex-sdk 0.2.0__py3-none-any.whl

vortex/models/merchant_tax_profile_request.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 typing_extensions import Annotated
+from vortex.models.merchant_tax_profile_request_registrations_inner import MerchantTaxProfileRequestRegistrationsInner
+from vortex.models.tax_address import TaxAddress
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class MerchantTaxProfileRequest(BaseModel):
+    """
+    MerchantTaxProfileRequest
+    """ # noqa: E501
+    environment: StrictStr
+    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
+    origin_address: TaxAddress = Field(alias="originAddress")
+    registrations: Annotated[List[MerchantTaxProfileRequestRegistrationsInner], Field(min_length=1)]
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["environment", "displayName", "originAddress", "registrations"]
+
+    @field_validator('environment')
+    def environment_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['sandbox', 'production']):
+            raise ValueError("must be one of enum values ('sandbox', 'production')")
+        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 MerchantTaxProfileRequest 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 origin_address
+        if self.origin_address:
+            _dict['originAddress'] = self.origin_address.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in registrations (list)
+        _items = []
+        if self.registrations:
+            for _item_registrations in self.registrations:
+                if _item_registrations:
+                    _items.append(_item_registrations.to_dict())
+            _dict['registrations'] = _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 MerchantTaxProfileRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "environment": obj.get("environment"),
+            "displayName": obj.get("displayName"),
+            "originAddress": TaxAddress.from_dict(obj["originAddress"]) if obj.get("originAddress") is not None else None,
+            "registrations": [MerchantTaxProfileRequestRegistrationsInner.from_dict(_item) for _item in obj["registrations"]] if obj.get("registrations") 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

vortex/models/merchant_tax_profile_request_registrations_inner.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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
+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 MerchantTaxProfileRequestRegistrationsInner(BaseModel):
+    """
+    MerchantTaxProfileRequestRegistrationsInner
+    """ # noqa: E501
+    country: StrictStr
+    region: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["country", "region"]
+
+    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 MerchantTaxProfileRequestRegistrationsInner 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MerchantTaxProfileRequestRegistrationsInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "country": obj.get("country"),
+            "region": obj.get("region")
+        })
+        return _obj

vortex/models/merchant_underwriting_data.py

@@ -0,0 +1,127 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from vortex.models.merchant_underwriting_data_card_volume_distribution import MerchantUnderwritingDataCardVolumeDistribution
+from vortex.models.merchant_underwriting_data_volume_distribution_by_business_type import MerchantUnderwritingDataVolumeDistributionByBusinessType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class MerchantUnderwritingData(BaseModel):
+    """
+    MerchantUnderwritingData
+    """ # noqa: E501
+    annual_ach_volume: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="annualAchVolume")
+    average_ach_transfer_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="averageAchTransferAmount")
+    average_card_transfer_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="averageCardTransferAmount")
+    business_description: Optional[StrictStr] = Field(default=None, alias="businessDescription")
+    credit_check_allowed: Optional[StrictBool] = Field(default=None, alias="creditCheckAllowed")
+    credit_check_ip_address: Optional[StrictStr] = Field(default=None, alias="creditCheckIpAddress")
+    credit_check_timestamp: Optional[StrictStr] = Field(default=None, alias="creditCheckTimestamp")
+    credit_check_user_agent: Optional[StrictStr] = Field(default=None, alias="creditCheckUserAgent")
+    refund_policy: Optional[StrictStr] = Field(default=None, alias="refundPolicy")
+    card_volume_distribution: Optional[MerchantUnderwritingDataCardVolumeDistribution] = Field(default=None, alias="cardVolumeDistribution")
+    volume_distribution_by_business_type: Optional[MerchantUnderwritingDataVolumeDistributionByBusinessType] = Field(default=None, alias="volumeDistributionByBusinessType")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["annualAchVolume", "averageAchTransferAmount", "averageCardTransferAmount", "businessDescription", "creditCheckAllowed", "creditCheckIpAddress", "creditCheckTimestamp", "creditCheckUserAgent", "refundPolicy", "cardVolumeDistribution", "volumeDistributionByBusinessType"]
+
+    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 MerchantUnderwritingData 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 card_volume_distribution
+        if self.card_volume_distribution:
+            _dict['cardVolumeDistribution'] = self.card_volume_distribution.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of volume_distribution_by_business_type
+        if self.volume_distribution_by_business_type:
+            _dict['volumeDistributionByBusinessType'] = self.volume_distribution_by_business_type.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 MerchantUnderwritingData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "annualAchVolume": obj.get("annualAchVolume"),
+            "averageAchTransferAmount": obj.get("averageAchTransferAmount"),
+            "averageCardTransferAmount": obj.get("averageCardTransferAmount"),
+            "businessDescription": obj.get("businessDescription"),
+            "creditCheckAllowed": obj.get("creditCheckAllowed"),
+            "creditCheckIpAddress": obj.get("creditCheckIpAddress"),
+            "creditCheckTimestamp": obj.get("creditCheckTimestamp"),
+            "creditCheckUserAgent": obj.get("creditCheckUserAgent"),
+            "refundPolicy": obj.get("refundPolicy"),
+            "cardVolumeDistribution": MerchantUnderwritingDataCardVolumeDistribution.from_dict(obj["cardVolumeDistribution"]) if obj.get("cardVolumeDistribution") is not None else None,
+            "volumeDistributionByBusinessType": MerchantUnderwritingDataVolumeDistributionByBusinessType.from_dict(obj["volumeDistributionByBusinessType"]) if obj.get("volumeDistributionByBusinessType") 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

vortex/models/merchant_underwriting_data_card_volume_distribution.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class MerchantUnderwritingDataCardVolumeDistribution(BaseModel):
+    """
+    MerchantUnderwritingDataCardVolumeDistribution
+    """ # noqa: E501
+    card_present_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="cardPresentPercentage")
+    ecommerce_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ecommercePercentage")
+    mail_order_telephone_order_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="mailOrderTelephoneOrderPercentage")
+    __properties: ClassVar[List[str]] = ["cardPresentPercentage", "ecommercePercentage", "mailOrderTelephoneOrderPercentage"]
+
+    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 MerchantUnderwritingDataCardVolumeDistribution 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MerchantUnderwritingDataCardVolumeDistribution from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cardPresentPercentage": obj.get("cardPresentPercentage"),
+            "ecommercePercentage": obj.get("ecommercePercentage"),
+            "mailOrderTelephoneOrderPercentage": obj.get("mailOrderTelephoneOrderPercentage")
+        })
+        return _obj

vortex/models/merchant_underwriting_data_volume_distribution_by_business_type.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class MerchantUnderwritingDataVolumeDistributionByBusinessType(BaseModel):
+    """
+    MerchantUnderwritingDataVolumeDistributionByBusinessType
+    """ # noqa: E501
+    business_to_consumer_volume_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="businessToConsumerVolumePercentage")
+    consumer_to_consumer_volume_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="consumerToConsumerVolumePercentage")
+    other_volume_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="otherVolumePercentage")
+    __properties: ClassVar[List[str]] = ["businessToConsumerVolumePercentage", "consumerToConsumerVolumePercentage", "otherVolumePercentage"]
+
+    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 MerchantUnderwritingDataVolumeDistributionByBusinessType 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MerchantUnderwritingDataVolumeDistributionByBusinessType from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "businessToConsumerVolumePercentage": obj.get("businessToConsumerVolumePercentage"),
+            "consumerToConsumerVolumePercentage": obj.get("consumerToConsumerVolumePercentage"),
+            "otherVolumePercentage": obj.get("otherVolumePercentage")
+        })
+        return _obj

vortex/models/open_api_invoice_tax_response.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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
+from vortex.models.open_api_invoice_tax_response_all_of_data import OpenApiInvoiceTaxResponseAllOfData
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class OpenApiInvoiceTaxResponse(BaseModel):
+    """
+    OpenApiInvoiceTaxResponse
+    """ # noqa: E501
+    data: OpenApiInvoiceTaxResponseAllOfData
+    request_id: StrictStr = Field(alias="requestId")
+    __properties: ClassVar[List[str]] = ["data", "requestId"]
+
+    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 OpenApiInvoiceTaxResponse 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _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()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OpenApiInvoiceTaxResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": OpenApiInvoiceTaxResponseAllOfData.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "requestId": obj.get("requestId")
+        })
+        return _obj