vortex-sdk 0.2.0__py3-none-any.whl

vortex/models/create_installment_payable_request.py

@@ -0,0 +1,170 @@
+# 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, StrictStr, field_validator
+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 CreateInstallmentPayableRequest(BaseModel):
+    """
+    CreateInstallmentPayableRequest
+    """ # noqa: E501
+    source_type: StrictStr = Field(alias="sourceType")
+    source_id: StrictStr = Field(alias="sourceId")
+    document_id: StrictStr = Field(alias="documentId")
+    payment_field_id: StrictStr = Field(alias="paymentFieldId")
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    billing_account_id: StrictStr = Field(alias="billingAccountId")
+    merchant_account_id: Optional[StrictStr] = Field(default=None, alias="merchantAccountId")
+    currency: StrictStr = Field(description="ISO 4217 alpha-3; only currencies processable on current rails are accepted", json_schema_extra={"examples": ["USD"]})
+    tax_mode: StrictStr = Field(alias="taxMode")
+    taxable: Optional[StrictBool] = None
+    tax_behavior: Optional[StrictStr] = Field(default=None, alias="taxBehavior")
+    tax_classification_key: Optional[StrictStr] = Field(default=None, alias="taxClassificationKey")
+    collection_intent: StrictStr = Field(alias="collectionIntent")
+    fee_policy: Dict[str, Any] = Field(description="Adopter fee policy (modeled, not settlement-executed). Structure passed through to Vortex Payments.", alias="feePolicy")
+    installments: List[Dict[str, Any]]
+    metadata: Dict[str, StrictStr]
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["sourceType", "sourceId", "documentId", "paymentFieldId", "customerExternalId", "billingAccountId", "merchantAccountId", "currency", "taxMode", "taxable", "taxBehavior", "taxClassificationKey", "collectionIntent", "feePolicy", "installments", "metadata"]
+
+    @field_validator('source_type')
+    def source_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['document_payment_field']):
+            raise ValueError("must be one of enum values ('document_payment_field')")
+        return value
+
+    @field_validator('tax_mode')
+    def tax_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['not_taxable', 'taxable_requires_evidence']):
+            raise ValueError("must be one of enum values ('not_taxable', 'taxable_requires_evidence')")
+        return value
+
+    @field_validator('tax_behavior')
+    def tax_behavior_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['inclusive', 'exclusive']):
+            raise ValueError("must be one of enum values ('inclusive', 'exclusive')")
+        return value
+
+    @field_validator('tax_classification_key')
+    def tax_classification_key_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['standard_taxable']):
+            raise ValueError("must be one of enum values ('standard_taxable')")
+        return value
+
+    @field_validator('collection_intent')
+    def collection_intent_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['manual']):
+            raise ValueError("must be one of enum values ('manual')")
+        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 CreateInstallmentPayableRequest 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 CreateInstallmentPayableRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceType": obj.get("sourceType"),
+            "sourceId": obj.get("sourceId"),
+            "documentId": obj.get("documentId"),
+            "paymentFieldId": obj.get("paymentFieldId"),
+            "customerExternalId": obj.get("customerExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "merchantAccountId": obj.get("merchantAccountId"),
+            "currency": obj.get("currency"),
+            "taxMode": obj.get("taxMode"),
+            "taxable": obj.get("taxable"),
+            "taxBehavior": obj.get("taxBehavior"),
+            "taxClassificationKey": obj.get("taxClassificationKey"),
+            "collectionIntent": obj.get("collectionIntent"),
+            "feePolicy": obj.get("feePolicy"),
+            "installments": obj.get("installments"),
+            "metadata": obj.get("metadata")
+        })
+        # 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/create_payable_request.py

@@ -0,0 +1,158 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+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 CreatePayableRequest(BaseModel):
+    """
+    CreatePayableRequest
+    """ # noqa: E501
+    source_type: StrictStr = Field(alias="sourceType")
+    source_id: StrictStr = Field(alias="sourceId")
+    document_id: StrictStr = Field(alias="documentId")
+    payment_field_id: StrictStr = Field(alias="paymentFieldId")
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    billing_account_id: StrictStr = Field(alias="billingAccountId")
+    collection_intent: StrictStr = Field(alias="collectionIntent")
+    fee_policy: Dict[str, Any] = Field(description="Adopter fee policy (modeled, not settlement-executed). Structure passed through to Vortex Payments.", alias="feePolicy")
+    due_at: Optional[datetime] = Field(default=None, alias="dueAt")
+    line_items: List[Dict[str, Any]] = Field(alias="lineItems")
+    taxable: Optional[StrictBool] = None
+    tax_behavior: Optional[StrictStr] = Field(default=None, alias="taxBehavior")
+    tax_classification_key: Optional[StrictStr] = Field(default=None, alias="taxClassificationKey")
+    customer_tax_address: Optional[TaxAddress] = Field(default=None, alias="customerTaxAddress")
+    ship_from_address: Optional[TaxAddress] = Field(default=None, alias="shipFromAddress")
+    metadata: Dict[str, StrictStr]
+    __properties: ClassVar[List[str]] = ["sourceType", "sourceId", "documentId", "paymentFieldId", "customerExternalId", "billingAccountId", "collectionIntent", "feePolicy", "dueAt", "lineItems", "taxable", "taxBehavior", "taxClassificationKey", "customerTaxAddress", "shipFromAddress", "metadata"]
+
+    @field_validator('source_type')
+    def source_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['document_payment_field']):
+            raise ValueError("must be one of enum values ('document_payment_field')")
+        return value
+
+    @field_validator('collection_intent')
+    def collection_intent_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['manual']):
+            raise ValueError("must be one of enum values ('manual')")
+        return value
+
+    @field_validator('tax_behavior')
+    def tax_behavior_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['inclusive', 'exclusive']):
+            raise ValueError("must be one of enum values ('inclusive', 'exclusive')")
+        return value
+
+    @field_validator('tax_classification_key')
+    def tax_classification_key_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['standard_taxable']):
+            raise ValueError("must be one of enum values ('standard_taxable')")
+        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 CreatePayableRequest 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 customer_tax_address
+        if self.customer_tax_address:
+            _dict['customerTaxAddress'] = self.customer_tax_address.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of ship_from_address
+        if self.ship_from_address:
+            _dict['shipFromAddress'] = self.ship_from_address.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreatePayableRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceType": obj.get("sourceType"),
+            "sourceId": obj.get("sourceId"),
+            "documentId": obj.get("documentId"),
+            "paymentFieldId": obj.get("paymentFieldId"),
+            "customerExternalId": obj.get("customerExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "collectionIntent": obj.get("collectionIntent"),
+            "feePolicy": obj.get("feePolicy"),
+            "dueAt": obj.get("dueAt"),
+            "lineItems": obj.get("lineItems"),
+            "taxable": obj.get("taxable"),
+            "taxBehavior": obj.get("taxBehavior"),
+            "taxClassificationKey": obj.get("taxClassificationKey"),
+            "customerTaxAddress": TaxAddress.from_dict(obj["customerTaxAddress"]) if obj.get("customerTaxAddress") is not None else None,
+            "shipFromAddress": TaxAddress.from_dict(obj["shipFromAddress"]) if obj.get("shipFromAddress") is not None else None,
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/create_recurring_payable_request.py

@@ -0,0 +1,181 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from vortex.models.create_recurring_payable_request_cadence import CreateRecurringPayableRequestCadence
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateRecurringPayableRequest(BaseModel):
+    """
+    CreateRecurringPayableRequest
+    """ # noqa: E501
+    source_type: StrictStr = Field(alias="sourceType")
+    source_id: StrictStr = Field(alias="sourceId")
+    document_id: StrictStr = Field(alias="documentId")
+    payment_field_id: StrictStr = Field(alias="paymentFieldId")
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    billing_account_id: StrictStr = Field(alias="billingAccountId")
+    merchant_account_id: Optional[StrictStr] = Field(default=None, alias="merchantAccountId")
+    currency: StrictStr = Field(description="ISO 4217 alpha-3; only currencies processable on current rails are accepted", json_schema_extra={"examples": ["USD"]})
+    line_items: List[Dict[str, Any]] = Field(alias="lineItems")
+    tax_mode: StrictStr = Field(alias="taxMode")
+    taxable: Optional[StrictBool] = None
+    tax_behavior: Optional[StrictStr] = Field(default=None, alias="taxBehavior")
+    tax_classification_key: Optional[StrictStr] = Field(default=None, alias="taxClassificationKey")
+    collection_intent: StrictStr = Field(alias="collectionIntent")
+    fee_policy: Dict[str, Any] = Field(description="Adopter fee policy (modeled, not settlement-executed). Structure passed through to Vortex Payments.", alias="feePolicy")
+    cadence: CreateRecurringPayableRequestCadence
+    end_policy: Dict[str, Any] = Field(alias="endPolicy")
+    start_at: datetime = Field(alias="startAt")
+    metadata: Dict[str, StrictStr]
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["sourceType", "sourceId", "documentId", "paymentFieldId", "customerExternalId", "billingAccountId", "merchantAccountId", "currency", "lineItems", "taxMode", "taxable", "taxBehavior", "taxClassificationKey", "collectionIntent", "feePolicy", "cadence", "endPolicy", "startAt", "metadata"]
+
+    @field_validator('source_type')
+    def source_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['document_payment_field']):
+            raise ValueError("must be one of enum values ('document_payment_field')")
+        return value
+
+    @field_validator('tax_mode')
+    def tax_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['not_taxable', 'taxable_requires_evidence']):
+            raise ValueError("must be one of enum values ('not_taxable', 'taxable_requires_evidence')")
+        return value
+
+    @field_validator('tax_behavior')
+    def tax_behavior_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['inclusive', 'exclusive']):
+            raise ValueError("must be one of enum values ('inclusive', 'exclusive')")
+        return value
+
+    @field_validator('tax_classification_key')
+    def tax_classification_key_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['standard_taxable']):
+            raise ValueError("must be one of enum values ('standard_taxable')")
+        return value
+
+    @field_validator('collection_intent')
+    def collection_intent_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['manual']):
+            raise ValueError("must be one of enum values ('manual')")
+        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 CreateRecurringPayableRequest 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 cadence
+        if self.cadence:
+            _dict['cadence'] = self.cadence.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 CreateRecurringPayableRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceType": obj.get("sourceType"),
+            "sourceId": obj.get("sourceId"),
+            "documentId": obj.get("documentId"),
+            "paymentFieldId": obj.get("paymentFieldId"),
+            "customerExternalId": obj.get("customerExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "merchantAccountId": obj.get("merchantAccountId"),
+            "currency": obj.get("currency"),
+            "lineItems": obj.get("lineItems"),
+            "taxMode": obj.get("taxMode"),
+            "taxable": obj.get("taxable"),
+            "taxBehavior": obj.get("taxBehavior"),
+            "taxClassificationKey": obj.get("taxClassificationKey"),
+            "collectionIntent": obj.get("collectionIntent"),
+            "feePolicy": obj.get("feePolicy"),
+            "cadence": CreateRecurringPayableRequestCadence.from_dict(obj["cadence"]) if obj.get("cadence") is not None else None,
+            "endPolicy": obj.get("endPolicy"),
+            "startAt": obj.get("startAt"),
+            "metadata": obj.get("metadata")
+        })
+        # 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/create_recurring_payable_request_cadence.py

@@ -0,0 +1,96 @@
+# 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
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateRecurringPayableRequestCadence(BaseModel):
+    """
+    CreateRecurringPayableRequestCadence
+    """ # noqa: E501
+    interval: StrictStr
+    interval_count: Annotated[int, Field(strict=True, ge=1)] = Field(alias="intervalCount")
+    __properties: ClassVar[List[str]] = ["interval", "intervalCount"]
+
+    @field_validator('interval')
+    def interval_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['week', 'month', 'year']):
+            raise ValueError("must be one of enum values ('week', 'month', 'year')")
+        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 CreateRecurringPayableRequestCadence 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 CreateRecurringPayableRequestCadence from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "interval": obj.get("interval"),
+            "intervalCount": obj.get("intervalCount")
+        })
+        return _obj