vortex-sdk 0.2.0__py3-none-any.whl

vortex/models/grant_entitlement_request.py

@@ -0,0 +1,106 @@
+# 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 import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class GrantEntitlementRequest(BaseModel):
+    """
+    GrantEntitlementRequest
+    """ # noqa: E501
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    billing_account_id: Optional[StrictStr] = Field(default=None, alias="billingAccountId")
+    entitlement_key: StrictStr = Field(alias="entitlementKey")
+    source: Optional[StrictStr] = None
+    source_ref: Optional[StrictStr] = Field(default=None, alias="sourceRef")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["customerExternalId", "billingAccountId", "entitlementKey", "source", "sourceRef", "metadata"]
+
+    @field_validator('source')
+    def source_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['subscription', 'operator', 'promotion']):
+            raise ValueError("must be one of enum values ('subscription', 'operator', 'promotion')")
+        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 GrantEntitlementRequest 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 GrantEntitlementRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "customerExternalId": obj.get("customerExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "entitlementKey": obj.get("entitlementKey"),
+            "source": obj.get("source"),
+            "sourceRef": obj.get("sourceRef"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/invoice_collect_request.py

@@ -0,0 +1,86 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class InvoiceCollectRequest(BaseModel):
+    """
+    InvoiceCollectRequest
+    """ # noqa: E501
+    payment_method_id: Optional[StrictStr] = Field(default=None, alias="paymentMethodId")
+    __properties: ClassVar[List[str]] = ["paymentMethodId"]
+
+    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 InvoiceCollectRequest 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 InvoiceCollectRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "paymentMethodId": obj.get("paymentMethodId")
+        })
+        return _obj

vortex/models/invoice_create_request.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class InvoiceCreateRequest(BaseModel):
+    """
+    InvoiceCreateRequest
+    """ # noqa: E501
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    subscription_external_id: Optional[StrictStr] = Field(default=None, alias="subscriptionExternalId")
+    billing_account_id: Optional[StrictStr] = Field(default=None, alias="billingAccountId")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["customerExternalId", "subscriptionExternalId", "billingAccountId", "metadata"]
+
+    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 InvoiceCreateRequest 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 InvoiceCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "customerExternalId": obj.get("customerExternalId"),
+            "subscriptionExternalId": obj.get("subscriptionExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/invoice_finalize_request.py

@@ -0,0 +1,86 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class InvoiceFinalizeRequest(BaseModel):
+    """
+    InvoiceFinalizeRequest
+    """ # noqa: E501
+    finalized_by_ref: Optional[StrictStr] = Field(default=None, alias="finalizedByRef")
+    __properties: ClassVar[List[str]] = ["finalizedByRef"]
+
+    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 InvoiceFinalizeRequest 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 InvoiceFinalizeRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "finalizedByRef": obj.get("finalizedByRef")
+        })
+        return _obj

vortex/models/invoice_mark_uncollectible_request.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, 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 InvoiceMarkUncollectibleRequest(BaseModel):
+    """
+    InvoiceMarkUncollectibleRequest
+    """ # noqa: E501
+    marked_uncollectible_by_ref: Optional[StrictStr] = Field(default=None, alias="markedUncollectibleByRef")
+    by: Optional[StrictStr] = None
+    reason: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["markedUncollectibleByRef", "by", "reason"]
+
+    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 InvoiceMarkUncollectibleRequest 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 InvoiceMarkUncollectibleRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "markedUncollectibleByRef": obj.get("markedUncollectibleByRef"),
+            "by": obj.get("by"),
+            "reason": obj.get("reason")
+        })
+        return _obj

vortex/models/invoice_tax.py

@@ -0,0 +1,142 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from vortex.models.tax_behavior_policy import TaxBehaviorPolicy
+from vortex.models.tax_failure import TaxFailure
+from vortex.models.tax_jurisdiction_evidence import TaxJurisdictionEvidence
+from vortex.models.tax_line_evidence import TaxLineEvidence
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class InvoiceTax(BaseModel):
+    """
+    InvoiceTax
+    """ # noqa: E501
+    invoice_number: StrictStr = Field(alias="invoiceNumber")
+    status: StrictStr
+    currency: StrictStr
+    subtotal: StrictInt
+    tax_total: StrictInt = Field(alias="taxTotal")
+    total: StrictInt
+    evidence_version: StrictStr = Field(alias="evidenceVersion")
+    tax_behavior_policy: TaxBehaviorPolicy = Field(alias="taxBehaviorPolicy")
+    quoted_at: Optional[datetime] = Field(default=None, alias="quotedAt")
+    finalized_at: Optional[datetime] = Field(default=None, alias="finalizedAt")
+    line_evidence: List[TaxLineEvidence] = Field(alias="lineEvidence")
+    jurisdiction_evidence: List[TaxJurisdictionEvidence] = Field(alias="jurisdictionEvidence")
+    failure: Optional[TaxFailure] = None
+    __properties: ClassVar[List[str]] = ["invoiceNumber", "status", "currency", "subtotal", "taxTotal", "total", "evidenceVersion", "taxBehaviorPolicy", "quotedAt", "finalizedAt", "lineEvidence", "jurisdictionEvidence", "failure"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['not_required', 'quote_pending', 'quoted', 'finalization_pending', 'finalized', 'failed', 'voided', 'reversed']):
+            raise ValueError("must be one of enum values ('not_required', 'quote_pending', 'quoted', 'finalization_pending', 'finalized', 'failed', 'voided', 'reversed')")
+        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 InvoiceTax 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 tax_behavior_policy
+        if self.tax_behavior_policy:
+            _dict['taxBehaviorPolicy'] = self.tax_behavior_policy.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in line_evidence (list)
+        _items = []
+        if self.line_evidence:
+            for _item_line_evidence in self.line_evidence:
+                if _item_line_evidence:
+                    _items.append(_item_line_evidence.to_dict())
+            _dict['lineEvidence'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in jurisdiction_evidence (list)
+        _items = []
+        if self.jurisdiction_evidence:
+            for _item_jurisdiction_evidence in self.jurisdiction_evidence:
+                if _item_jurisdiction_evidence:
+                    _items.append(_item_jurisdiction_evidence.to_dict())
+            _dict['jurisdictionEvidence'] = _items
+        # override the default output from pydantic by calling `to_dict()` of failure
+        if self.failure:
+            _dict['failure'] = self.failure.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InvoiceTax from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "invoiceNumber": obj.get("invoiceNumber"),
+            "status": obj.get("status"),
+            "currency": obj.get("currency"),
+            "subtotal": obj.get("subtotal"),
+            "taxTotal": obj.get("taxTotal"),
+            "total": obj.get("total"),
+            "evidenceVersion": obj.get("evidenceVersion"),
+            "taxBehaviorPolicy": TaxBehaviorPolicy.from_dict(obj["taxBehaviorPolicy"]) if obj.get("taxBehaviorPolicy") is not None else None,
+            "quotedAt": obj.get("quotedAt"),
+            "finalizedAt": obj.get("finalizedAt"),
+            "lineEvidence": [TaxLineEvidence.from_dict(_item) for _item in obj["lineEvidence"]] if obj.get("lineEvidence") is not None else None,
+            "jurisdictionEvidence": [TaxJurisdictionEvidence.from_dict(_item) for _item in obj["jurisdictionEvidence"]] if obj.get("jurisdictionEvidence") is not None else None,
+            "failure": TaxFailure.from_dict(obj["failure"]) if obj.get("failure") is not None else None
+        })
+        return _obj

vortex/models/invoice_void_request.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, Field, 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 InvoiceVoidRequest(BaseModel):
+    """
+    InvoiceVoidRequest
+    """ # noqa: E501
+    voided_by_ref: Optional[StrictStr] = Field(default=None, alias="voidedByRef")
+    reason: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["voidedByRef", "reason"]
+
+    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 InvoiceVoidRequest 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 InvoiceVoidRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "voidedByRef": obj.get("voidedByRef"),
+            "reason": obj.get("reason")
+        })
+        return _obj