vortex-sdk 0.2.0__py3-none-any.whl

vortex/models/revoke_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 RevokeEntitlementRequest(BaseModel):
+    """
+    RevokeEntitlementRequest
+    """ # 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")
+    reason: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["customerExternalId", "billingAccountId", "entitlementKey", "source", "sourceRef", "reason"]
+
+    @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 RevokeEntitlementRequest 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 RevokeEntitlementRequest 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"),
+            "reason": obj.get("reason")
+        })
+        return _obj

vortex/models/subscription_change_request.py

@@ -0,0 +1,111 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from vortex.models.subscription_item_change_request_item import SubscriptionItemChangeRequestItem
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class SubscriptionChangeRequest(BaseModel):
+    """
+    SubscriptionChangeRequest
+    """ # noqa: E501
+    action: StrictStr
+    cancel_at: Optional[datetime] = Field(default=None, alias="cancelAt")
+    effective_at: Optional[datetime] = Field(default=None, alias="effectiveAt")
+    items: Optional[Annotated[List[SubscriptionItemChangeRequestItem], Field(min_length=1)]] = None
+    requested_by_ref: Optional[StrictStr] = Field(default=None, alias="requestedByRef")
+    __properties: ClassVar[List[str]] = ["action", "cancelAt", "effectiveAt", "items", "requestedByRef"]
+
+    @field_validator('action')
+    def action_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['pause', 'resume', 'cancel', 'update_items']):
+            raise ValueError("must be one of enum values ('pause', 'resume', 'cancel', 'update_items')")
+        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 SubscriptionChangeRequest 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 each item in items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionChangeRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "action": obj.get("action"),
+            "cancelAt": obj.get("cancelAt"),
+            "effectiveAt": obj.get("effectiveAt"),
+            "items": [SubscriptionItemChangeRequestItem.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "requestedByRef": obj.get("requestedByRef")
+        })
+        return _obj

vortex/models/subscription_create_request.py

@@ -0,0 +1,122 @@
+# 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, 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 SubscriptionCreateRequest(BaseModel):
+    """
+    SubscriptionCreateRequest
+    """ # noqa: E501
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    subscription_external_id: StrictStr = Field(alias="subscriptionExternalId")
+    plan_code: StrictStr = Field(alias="planCode")
+    collection_mode: Optional[StrictStr] = Field(default=None, alias="collectionMode")
+    items: Optional[List[Dict[str, Any]]] = None
+    trial_ends_at: Optional[datetime] = Field(default=None, alias="trialEndsAt")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["customerExternalId", "subscriptionExternalId", "planCode", "collectionMode", "items", "trialEndsAt", "metadata"]
+
+    @field_validator('collection_mode')
+    def collection_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['automatic', 'manual']):
+            raise ValueError("must be one of enum values ('automatic', '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 SubscriptionCreateRequest 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 SubscriptionCreateRequest 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"),
+            "planCode": obj.get("planCode"),
+            "collectionMode": obj.get("collectionMode"),
+            "items": obj.get("items"),
+            "trialEndsAt": obj.get("trialEndsAt"),
+            "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/subscription_item_change_preview_request.py

@@ -0,0 +1,100 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from vortex.models.subscription_item_change_request_item import SubscriptionItemChangeRequestItem
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class SubscriptionItemChangePreviewRequest(BaseModel):
+    """
+    SubscriptionItemChangePreviewRequest
+    """ # noqa: E501
+    effective_at: Optional[datetime] = Field(default=None, alias="effectiveAt")
+    items: Annotated[List[SubscriptionItemChangeRequestItem], Field(min_length=1)]
+    requested_by_ref: Optional[StrictStr] = Field(default=None, alias="requestedByRef")
+    __properties: ClassVar[List[str]] = ["effectiveAt", "items", "requestedByRef"]
+
+    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 SubscriptionItemChangePreviewRequest 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 each item in items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionItemChangePreviewRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "effectiveAt": obj.get("effectiveAt"),
+            "items": [SubscriptionItemChangeRequestItem.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "requestedByRef": obj.get("requestedByRef")
+        })
+        return _obj

vortex/models/subscription_item_change_request_item.py

@@ -0,0 +1,91 @@
+# 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_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class SubscriptionItemChangeRequestItem(BaseModel):
+    """
+    SubscriptionItemChangeRequestItem
+    """ # noqa: E501
+    price_id: StrictStr = Field(alias="priceId")
+    quantity: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["priceId", "quantity", "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 SubscriptionItemChangeRequestItem 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 SubscriptionItemChangeRequestItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "priceId": obj.get("priceId"),
+            "quantity": obj.get("quantity"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/tax_address.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
+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 TaxAddress(BaseModel):
+    """
+    TaxAddress
+    """ # noqa: E501
+    line1: StrictStr
+    line2: Optional[StrictStr] = None
+    city: StrictStr
+    region: StrictStr
+    postal_code: StrictStr = Field(alias="postalCode")
+    country: StrictStr
+    __properties: ClassVar[List[str]] = ["line1", "line2", "city", "region", "postalCode", "country"]
+
+    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 TaxAddress 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 TaxAddress from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "line1": obj.get("line1"),
+            "line2": obj.get("line2"),
+            "city": obj.get("city"),
+            "region": obj.get("region"),
+            "postalCode": obj.get("postalCode"),
+            "country": obj.get("country")
+        })
+        return _obj

vortex/models/tax_behavior.py

@@ -0,0 +1,36 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TaxBehavior(str, Enum):
+    """
+    TaxBehavior
+    """
+
+    """
+    allowed enum values
+    """
+    EXCLUSIVE = 'exclusive'
+    INCLUSIVE = 'inclusive'
+    LOCATION_BASED = 'location_based'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TaxBehavior from a JSON string"""
+        return cls(json.loads(json_str))