vortex-sdk 0.2.0__py3-none-any.whl

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

vortex/models/customer_payment_method_attach_request.py

@@ -0,0 +1,94 @@
+# 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
+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 CustomerPaymentMethodAttachRequest(BaseModel):
+    """
+    CustomerPaymentMethodAttachRequest
+    """ # noqa: E501
+    billing_account_id: Optional[StrictStr] = Field(default=None, alias="billingAccountId")
+    payment_method_setup_session_id: StrictStr = Field(alias="paymentMethodSetupSessionId")
+    setup_token: StrictStr = Field(alias="setupToken")
+    set_as_default: Optional[StrictBool] = Field(default=None, alias="setAsDefault")
+    idempotency_key: Optional[StrictStr] = Field(default=None, alias="idempotencyKey")
+    __properties: ClassVar[List[str]] = ["billingAccountId", "paymentMethodSetupSessionId", "setupToken", "setAsDefault", "idempotencyKey"]
+
+    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 CustomerPaymentMethodAttachRequest 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 CustomerPaymentMethodAttachRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "billingAccountId": obj.get("billingAccountId"),
+            "paymentMethodSetupSessionId": obj.get("paymentMethodSetupSessionId"),
+            "setupToken": obj.get("setupToken"),
+            "setAsDefault": obj.get("setAsDefault"),
+            "idempotencyKey": obj.get("idempotencyKey")
+        })
+        return _obj

vortex/models/customer_payment_method_setup_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 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 CustomerPaymentMethodSetupRequest(BaseModel):
+    """
+    CustomerPaymentMethodSetupRequest
+    """ # noqa: E501
+    billing_account_id: Optional[StrictStr] = Field(default=None, alias="billingAccountId")
+    method_type: Optional[StrictStr] = Field(default=None, alias="methodType")
+    set_as_default: Optional[StrictBool] = Field(default=None, alias="setAsDefault")
+    __properties: ClassVar[List[str]] = ["billingAccountId", "methodType", "setAsDefault"]
+
+    @field_validator('method_type')
+    def method_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['card']):
+            raise ValueError("must be one of enum values ('card')")
+        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 CustomerPaymentMethodSetupRequest 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 CustomerPaymentMethodSetupRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "billingAccountId": obj.get("billingAccountId"),
+            "methodType": obj.get("methodType"),
+            "setAsDefault": obj.get("setAsDefault")
+        })
+        return _obj

vortex/models/customer_upsert_request.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 CustomerUpsertRequest(BaseModel):
+    """
+    CustomerUpsertRequest
+    """ # noqa: E501
+    email: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    billing_currency: Optional[StrictStr] = Field(default=None, alias="billingCurrency", json_schema_extra={"examples": ["USD"]})
+    customer_profile_id: Optional[StrictStr] = Field(default=None, description="Vortex Payments customer profile id. No provider ids.", alias="customerProfileId")
+    timezone: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["America/New_York"]})
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["email", "name", "billingCurrency", "customerProfileId", "timezone", "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 CustomerUpsertRequest 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 CustomerUpsertRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "email": obj.get("email"),
+            "name": obj.get("name"),
+            "billingCurrency": obj.get("billingCurrency"),
+            "customerProfileId": obj.get("customerProfileId"),
+            "timezone": obj.get("timezone"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/expire_customer_balance_request.py

@@ -0,0 +1,98 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ExpireCustomerBalanceRequest(BaseModel):
+    """
+    ExpireCustomerBalanceRequest
+    """ # noqa: E501
+    entry_id: Optional[StrictStr] = Field(default=None, alias="entryId")
+    source_entry_id: StrictStr = Field(alias="sourceEntryId")
+    amount: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    description: Optional[StrictStr] = None
+    effective_at: Optional[datetime] = Field(default=None, alias="effectiveAt")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["entryId", "sourceEntryId", "amount", "description", "effectiveAt", "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 ExpireCustomerBalanceRequest 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 ExpireCustomerBalanceRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "entryId": obj.get("entryId"),
+            "sourceEntryId": obj.get("sourceEntryId"),
+            "amount": obj.get("amount"),
+            "description": obj.get("description"),
+            "effectiveAt": obj.get("effectiveAt"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/grant_customer_balance_from_payment_request.py

@@ -0,0 +1,103 @@
+# 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 vortex.models.customer_balance_targets import CustomerBalanceTargets
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class GrantCustomerBalanceFromPaymentRequest(BaseModel):
+    """
+    GrantCustomerBalanceFromPaymentRequest
+    """ # noqa: E501
+    entry_id: Optional[StrictStr] = Field(default=None, alias="entryId")
+    payment_id: StrictStr = Field(alias="paymentId")
+    targets: Optional[CustomerBalanceTargets] = None
+    description: Optional[StrictStr] = None
+    effective_at: Optional[datetime] = Field(default=None, alias="effectiveAt")
+    expires_at: Optional[datetime] = Field(default=None, alias="expiresAt")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["entryId", "paymentId", "targets", "description", "effectiveAt", "expiresAt", "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 GrantCustomerBalanceFromPaymentRequest 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 targets
+        if self.targets:
+            _dict['targets'] = self.targets.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GrantCustomerBalanceFromPaymentRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "entryId": obj.get("entryId"),
+            "paymentId": obj.get("paymentId"),
+            "targets": CustomerBalanceTargets.from_dict(obj["targets"]) if obj.get("targets") is not None else None,
+            "description": obj.get("description"),
+            "effectiveAt": obj.get("effectiveAt"),
+            "expiresAt": obj.get("expiresAt"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/grant_customer_balance_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 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.customer_balance_targets import CustomerBalanceTargets
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class GrantCustomerBalanceRequest(BaseModel):
+    """
+    GrantCustomerBalanceRequest
+    """ # noqa: E501
+    entry_id: Optional[StrictStr] = Field(default=None, alias="entryId")
+    currency: StrictStr
+    amount: Annotated[int, Field(strict=True, ge=1)]
+    targets: Optional[CustomerBalanceTargets] = None
+    description: Optional[StrictStr] = None
+    effective_at: Optional[datetime] = Field(default=None, alias="effectiveAt")
+    expires_at: Optional[datetime] = Field(default=None, alias="expiresAt")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["entryId", "currency", "amount", "targets", "description", "effectiveAt", "expiresAt", "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 GrantCustomerBalanceRequest 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 targets
+        if self.targets:
+            _dict['targets'] = self.targets.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GrantCustomerBalanceRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "entryId": obj.get("entryId"),
+            "currency": obj.get("currency"),
+            "amount": obj.get("amount"),
+            "targets": CustomerBalanceTargets.from_dict(obj["targets"]) if obj.get("targets") is not None else None,
+            "description": obj.get("description"),
+            "effectiveAt": obj.get("effectiveAt"),
+            "expiresAt": obj.get("expiresAt"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj